From eb41d084af67b7413ab84ccda48025cba8773167 Mon Sep 17 00:00:00 2001 From: Luca Martial <48870843+luca-martial@users.noreply.github.com> Date: Mon, 18 May 2026 19:47:28 -0400 Subject: [PATCH] docs: align readme quickstart (#138) --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d9df7377..73c11d20 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ SQLite. ## Quick Start ```bash -pnpm add --global @kaelio/ktx +npm install -g @kaelio/ktx ktx setup ktx status ``` @@ -49,8 +49,8 @@ KTX project: /home/user/analytics Project ready: yes LLM ready: yes (claude-sonnet-4-6) Embeddings ready: yes (text-embedding-3-small) -Databases configured: yes (postgres-warehouse) -Context sources configured: yes (dbt-main) +Databases configured: yes (warehouse) +Context sources configured: yes (dbt_main) KTX context built: yes Agent integration ready: yes (codex:project) ``` @@ -63,9 +63,9 @@ Agent integration ready: yes (codex:project) | `ktx status` | Check project readiness | | `ktx connection list` | List configured connections | | `ktx connection test ` | Test one connection | -| `ktx ingest ` | Build context for one connection | +| `ktx ingest ` | Build context for one connection | | `ktx ingest --all` | Build context for every configured connection | -| `ktx ingest text ` | Capture free-form notes into memory | +| `ktx ingest text --connection-id ` | Capture free-form notes into memory | | `ktx sl list` | List semantic-layer sources | | `ktx sl search "revenue"` | Search semantic-layer sources | | `ktx sl validate --connection-id ` | Validate a semantic source | @@ -97,9 +97,12 @@ Setup can install KTX instructions for Claude Code, Codex, Cursor, OpenCode, and universal `.agents` clients: ```bash -ktx setup --agents --target codex +ktx setup --agents ``` +Use `--target ` when you want to install or repair one specific +integration. + Agent-facing workflows typically start with: ```bash