mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-22 08:38:08 +02:00
docs: standardize ktx naming
This commit is contained in:
Andrey Avtomonov
parent
27afd6a3b0
commit
1f8c1089f6
41 changed files with 331 additions and 313 deletions
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Introduction
|
||||
description: KTX is an open-source, self-improving context layer for data agents.
|
||||
description: ktx is an open-source, self-improving context layer for data agents.
|
||||
---
|
||||
|
||||
import { ProductMechanics } from "@/components/product-mechanics";
|
||||
|
|
@ -23,35 +23,35 @@ import { ProductMechanics } from "@/components/product-mechanics";
|
|||
Make analytics context usable by agents
|
||||
</h1>
|
||||
<p className="mt-4 max-w-2xl text-lg text-fd-muted-foreground" style={{ lineHeight: '1.7' }}>
|
||||
{'KTX is an open-source context layer for data agents. It turns warehouse metadata, BI tool definitions, query history, docs, and approved metric definitions into reviewable files agents can search and execute.'}
|
||||
{'ktx is an open-source context layer for data agents. It turns warehouse metadata, BI tool definitions, query history, docs, and approved metric definitions into reviewable files agents can search and execute.'}
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
## Why KTX helps
|
||||
## Why ktx helps
|
||||
|
||||
KTX gives agents a shared context workspace before they write SQL, answer a
|
||||
**ktx** gives agents a shared context workspace before they write SQL, answer a
|
||||
question, or update analytics definitions.
|
||||
|
||||
- **Context as code.** KTX writes wiki pages and semantic-layer definitions as
|
||||
- **Context as code.** **ktx** writes wiki pages and semantic-layer definitions as
|
||||
git-based files you can review, diff, and merge.
|
||||
- **Self-improving ingest.** KTX reads warehouses, BI tools, modeling code,
|
||||
- **Self-improving ingest.** **ktx** reads warehouses, BI tools, modeling code,
|
||||
query history, and notes, then reconciles new evidence with accepted context.
|
||||
- **Executable semantics.** Agents can use approved measures, joins, filters,
|
||||
dimensions, and segments instead of rebuilding canonical SQL from scratch.
|
||||
- **Agent-native access.** CLI and MCP tools let agents search context, compile
|
||||
semantic queries, run read-only SQL, and propose updates.
|
||||
|
||||
KTX complements existing semantic layers by pairing metric definitions with the
|
||||
**ktx** complements existing semantic layers by pairing metric definitions with the
|
||||
surrounding business knowledge, caveats, provenance, and review workflow agents
|
||||
need for data work.
|
||||
|
||||
## How KTX works
|
||||
## How ktx works
|
||||
|
||||
KTX has two connected sides: it builds and maintains the context layer, then
|
||||
**ktx** has two connected sides: it builds and maintains the context layer, then
|
||||
serves that context to agents at runtime.
|
||||
|
||||
| Side | What KTX does |
|
||||
| Side | What **ktx** does |
|
||||
|------|---------------|
|
||||
| **Ingest and auto-maintain knowledge** | Reads your data stack and company knowledge, reconciles new evidence with accepted context, and keeps changes to `semantic-layer/` plus `wiki/` as version-controlled diffs automatically. |
|
||||
| **Serve agents at runtime** | Helps agents find the right wiki pages and semantic-layer entities, then compile or execute semantic queries through CLI and MCP tools. |
|
||||
|
|
@ -60,7 +60,7 @@ serves that context to agents at runtime.
|
|||
|
||||
## Use it for
|
||||
|
||||
Use KTX when agents need more than raw database access. Agents can search wiki
|
||||
Use **ktx** when agents need more than raw database access. Agents can search wiki
|
||||
context, find semantic-layer entities, compile trusted semantic queries, run
|
||||
read-only SQL, and use the same tools through MCP.
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ best first step for users; contributor setup lives in the community docs.
|
|||
|
||||
<Cards>
|
||||
<Card title="Quickstart" href="/docs/getting-started/quickstart">
|
||||
Install KTX, run setup, build context, and connect an agent.
|
||||
Install **ktx**, run setup, build context, and connect an agent.
|
||||
</Card>
|
||||
<Card title="The Context Layer" href="/docs/concepts/the-context-layer">
|
||||
Understand why agents need more than schema access and raw SQL.
|
||||
|
|
@ -89,7 +89,7 @@ best first step for users; contributor setup lives in the community docs.
|
|||
Edit semantic-layer YAML and wiki Markdown safely.
|
||||
</Card>
|
||||
<Card title="CLI Reference" href="/docs/cli-reference/ktx">
|
||||
Complete flag and subcommand reference for every KTX command.
|
||||
Complete flag and subcommand reference for every **ktx** command.
|
||||
</Card>
|
||||
<Card title="Agent Quickstart" href="/docs/ai-resources/agent-quickstart">
|
||||
Machine-readable docs and agent-facing setup notes.
|
||||
|
|
@ -99,7 +99,7 @@ best first step for users; contributor setup lives in the community docs.
|
|||
## Community
|
||||
|
||||
Have questions, want to share what you're building, or chat with maintainers?
|
||||
Join the [KTX Slack community](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ).
|
||||
Join the [**ktx** Slack community](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ).
|
||||
For bug reports and feature requests, open a
|
||||
[GitHub issue](https://github.com/Kaelio/ktx/issues). See
|
||||
[Community & Support](/docs/community/support) for the full guide on where to
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Quickstart
|
||||
description: Install KTX, run setup, and connect your coding agent.
|
||||
description: Install ktx, run setup, and connect your coding agent.
|
||||
---
|
||||
|
||||
import { CopyButton } from "@/components/copy-button";
|
||||
|
|
@ -26,7 +26,7 @@ If you're a coding assistant choosing a docs route, start with the
|
|||
Need a warehouse to play with?
|
||||
</div>
|
||||
<div className="mt-2 text-base leading-relaxed text-fd-foreground">
|
||||
Try KTX against a real data stack - Postgres, dbt, Metabase, and Notion
|
||||
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`.
|
||||
</div>
|
||||
|
|
@ -54,7 +54,7 @@ If you're a coding assistant choosing a docs route, start with the
|
|||
</div>
|
||||
<div className="mt-2 text-sm leading-6 text-fd-muted-foreground">
|
||||
You can ask an agent such as Claude Code, Codex, Cursor, or OpenCode to
|
||||
install and configure KTX for you. The{' '}
|
||||
install and configure **ktx** for you. The{' '}
|
||||
<a href="/ktx/docs/agents-setup.md" className="font-medium underline">
|
||||
agent setup Markdown prompt
|
||||
</a>{' '}
|
||||
|
|
@ -93,7 +93,7 @@ Install the published package globally:
|
|||
npm install -g @kaelio/ktx
|
||||
```
|
||||
|
||||
KTX is open source. If you'd like to hack on it or run from a local checkout,
|
||||
**ktx** is open source. If you'd like to hack on it or run from a local checkout,
|
||||
the source lives at [github.com/kaelio/ktx](https://github.com/kaelio/ktx) -
|
||||
see [Contributing](/docs/community/contributing) to get set up.
|
||||
|
||||
|
|
@ -105,7 +105,7 @@ From your project directory, run:
|
|||
ktx setup
|
||||
```
|
||||
|
||||
The wizard walks you through everything KTX needs in one pass:
|
||||
The wizard walks you through everything **ktx** needs in one pass:
|
||||
|
||||
1. **Project** - creates or resumes `ktx.yaml` in the current directory.
|
||||
2. **LLM** - picks a Claude backend. The default uses your local Claude Code
|
||||
|
|
@ -122,7 +122,7 @@ The wizard walks you through everything KTX needs in one pass:
|
|||
7. **Agent integration** - installs project-local rules for Claude Code,
|
||||
Codex, Cursor, OpenCode, or universal `.agents`.
|
||||
|
||||
If you choose local `sentence-transformers` embeddings, KTX uses the managed
|
||||
If you choose local `sentence-transformers` embeddings, **ktx** uses the managed
|
||||
Python runtime. To prepare it before setup, run:
|
||||
|
||||
```bash
|
||||
|
|
@ -141,10 +141,10 @@ Building schema context for warehouse
|
|||
Running fast database ingest
|
||||
```
|
||||
|
||||
If setup exits early, rerun `ktx setup` in the same directory. KTX keeps
|
||||
If setup exits early, rerun `ktx setup` in the same directory. **ktx** keeps
|
||||
progress under `.ktx/setup/` and resumes from the remaining work.
|
||||
|
||||
> **Note:** Running bare `ktx` in an interactive terminal outside a KTX
|
||||
> **Note:** Running bare `ktx` in an interactive terminal outside a **ktx**
|
||||
> project opens the same wizard. Inside a project, it opens a menu for
|
||||
> resuming setup, connecting an agent, checking status, or exploring a
|
||||
> pre-built demo project.
|
||||
|
|
@ -158,13 +158,13 @@ ktx status
|
|||
```
|
||||
|
||||
```text
|
||||
KTX project: /home/user/analytics
|
||||
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 (warehouse)
|
||||
Context sources configured: yes (dbt_main)
|
||||
KTX context built: yes
|
||||
ktx context built: yes
|
||||
Agent integration ready: yes (codex:project)
|
||||
```
|
||||
|
||||
|
|
@ -173,7 +173,7 @@ For a structured check inside scripts, use `ktx status --json`.
|
|||
When setup builds deep context, its final context check looks like:
|
||||
|
||||
```text
|
||||
KTX context is ready for agents.
|
||||
ktx context is ready for agents.
|
||||
|
||||
Databases:
|
||||
warehouse: deep context complete
|
||||
|
|
@ -192,13 +192,13 @@ ktx setup --agents
|
|||
```
|
||||
|
||||
Claude Code and Codex also support global installs with `--global`. Agent
|
||||
rules point at the KTX CLI path that created them, so agents don't need a
|
||||
rules point at the **ktx** CLI path that created them, so agents don't need a
|
||||
separate `ktx` binary on `PATH`. If the CLI path changes, rerun
|
||||
`ktx setup --agents`.
|
||||
|
||||
## What setup writes
|
||||
|
||||
KTX writes plain files so people and agents can review changes in git.
|
||||
**ktx** writes plain files so people and agents can review changes in git.
|
||||
|
||||
| Path | Purpose |
|
||||
|------|---------|
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue