mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
b9e0a746af
* feat(cli): clean up dev command surface * test: align CI expectations with CLI cleanup * test(cli): update slow test command expectations
60 lines
2.1 KiB
Text
60 lines
2.1 KiB
Text
---
|
|
title: "ktx dev"
|
|
description: "Low-level project initialization and runtime management."
|
|
---
|
|
|
|
`ktx dev` contains development-only project initialization and managed runtime commands. Scan and ingest commands live at the root as [`ktx scan`](/docs/cli-reference/ktx-scan) and [`ktx ingest`](/docs/cli-reference/ktx-ingest).
|
|
|
|
## Command signature
|
|
|
|
```bash
|
|
ktx dev <subcommand> [options]
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
| Subcommand | Description |
|
|
|-----------|-------------|
|
|
| `init [directory]` | Initialize a Git-backed KTX project directory |
|
|
| `runtime` | Install, start, stop, inspect, and prune the KTX-managed Python runtime |
|
|
|
|
## `dev init`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--name <name>` | Project name written to `ktx.yaml` | — |
|
|
| `--force` | Rewrite `ktx.yaml` and scaffold files in an existing project | `false` |
|
|
|
|
## `dev runtime`
|
|
|
|
`ktx dev runtime` supports `install`, `start`, `stop`, `status`, and `prune`.
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--feature <feature>` | Runtime feature level for `install`, `start`, and `status` (`core` or `local-embeddings`) | `core` |
|
|
| `--json` | Print JSON output for `status` | `false` |
|
|
| `--yes` | Confirm runtime install or prune actions where supported | `false` |
|
|
| `--force` | Reinstall or restart where supported | `false` |
|
|
| `--dry-run` | Preview runtime pruning without removing files | `false` |
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
ktx dev init
|
|
ktx dev init ./my-project --name "Analytics Context"
|
|
ktx dev init --force
|
|
|
|
ktx dev runtime install --yes
|
|
ktx dev runtime status
|
|
ktx dev runtime start
|
|
ktx dev runtime stop
|
|
ktx dev runtime prune --dry-run
|
|
ktx dev runtime prune --yes
|
|
```
|
|
|
|
## Common errors
|
|
|
|
| Error | Cause | Recovery |
|
|
|-------|-------|----------|
|
|
| Runtime status reports missing pieces | Packages, Python environment, or linked CLI are not ready | Run `pnpm install`, `pnpm run setup:dev`, `uv sync --all-groups`, then `ktx dev runtime status` |
|
|
| Runtime daemon does not start | The managed Python runtime is missing or stale | Run `ktx dev runtime install --yes`, then `ktx dev runtime start` |
|