ktx status

Run the ktx readiness doctor. Inside a ktx project, this checks setup, project configuration, semantic search, query history, connections, and related diagnostics. Outside a project, it checks local CLI setup readiness so you know whether ktx setup can run.

Command signature

ktx status [options]

Options

Examples

# Show project status
ktx status

# Get status as JSON without interactive input
ktx status --json --no-input

# Show all checks, not only warnings and failures
ktx status --verbose

# Validate ktx.yaml without running readiness checks
ktx status --validate

# Skip slow probes (query-history readiness, Claude Code auth, Codex auth)
ktx status --fast

# Check a project from another directory
ktx status --project-dir ./analytics

Output

ktx status prints grouped doctor checks. Agents should use ktx status --json --no-input when they need to branch on readiness state.

For llm.provider.backend: claude-code, ktx status checks that the local Claude Code session is usable. If auth fails, run the Claude Code CLI login flow, then rerun ktx status. Use --fast to skip this probe (useful in CI or offline contexts); skipped checks render as - and carry "status": "skipped" in JSON output.

For llm.provider.backend: codex, ktx status runs a minimal non-interactive Codex request. If the probe fails, authenticate Codex locally with the Codex CLI and verify the Codex CLI installation.

When llm.provider.backend: codex is configured, ktx status also prints a warning when the installed public Codex SDK and CLI surface cannot prove full Claude-Code-style isolation. The warning does not block authenticated Codex usage, but it marks the project status as partial so you can make an explicit runtime-isolation decision.

A Local data section summarises what the project has accumulated locally: ingest run counts, last completed timestamp per connection, knowledge page counts by scope, semantic-layer source and dictionary value counts, and the on-disk size of .ktx/db.sqlite, .ktx/cache/, raw-sources/, wiki/global/, and semantic-layer/. These are read from .ktx/db.sqlite and local file stats, and are always shown (they do not require external communication).

{
  "title": "ktx project doctor",
  "checks": [
    {
      "id": "project-config",
      "label": "Project config",
      "status": "pass",
      "detail": "warehouse"
    }
  ]
}

Common errors