diff --git a/docs-site/content/docs/getting-started/quickstart.mdx b/docs-site/content/docs/getting-started/quickstart.mdx index 6f65d6ec..7402d6d9 100644 --- a/docs-site/content/docs/getting-started/quickstart.mdx +++ b/docs-site/content/docs/getting-started/quickstart.mdx @@ -30,8 +30,9 @@ If you're a coding assistant choosing a docs route, start with the
Try **ktx** against a real data stack - Postgres, dbt, Metabase, and Notion - pre-loaded with the Orbit demo corpus. The page lists demo credentials - you can paste straight into `ktx setup`. + pre-loaded with the Orbit demo corpus. Hit **copy agent setup** on the page + for a one-shot prompt that has an agent install the full four-source demo, + or grab the raw credentials to paste into `ktx setup` yourself.
`. +Prefer `env:VAR` / `file:/abs/path` refs for keys and tokens over literals. + +```bash +# dbt — pick exactly one of --source-path (local) or --source-git-url (remote) +ktx setup --no-input --yes --skip-databases --skip-llm --skip-embeddings \ + --source dbt --source-connection-id \ + --source-git-url --source-branch \ + --source-warehouse-connection-id + +# Metabase +ktx setup --no-input --yes --skip-databases --skip-llm --skip-embeddings \ + --source metabase --source-connection-id \ + --source-url --source-api-key-ref env:METABASE_API_KEY \ + --source-warehouse-connection-id \ + --metabase-database-id + +# Notion +ktx setup --no-input --yes --skip-databases --skip-llm --skip-embeddings \ + --source notion --source-connection-id \ + --source-api-key-ref env:NOTION_TOKEN \ + --notion-crawl-mode selected_roots --notion-root-page-id +``` + +Notes: + +- `--metabase-database-id` is the **numeric id of the warehouse inside + Metabase** (not the ktx connection id). Discover it from the Metabase API + (`GET /api/database`) or UI if the user doesn't know it. +- `--notion-crawl-mode selected_roots` requires at least one + `--notion-root-page-id` (repeatable); use `all_accessible` to crawl + everything the token can see. +- After adding sources, ingest each new connection so its context is queryable: + `ktx ingest --fast --no-input`. + ## Files to inspect - `ktx.yaml`: project configuration.