mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-10 11:12:10 +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,10 +1,10 @@
|
|||
---
|
||||
title: Building Context
|
||||
description: Build and refresh KTX context from databases, context sources, query history, and text.
|
||||
description: Build and refresh ktx context from databases, context sources, query history, and text.
|
||||
---
|
||||
|
||||
Build context after `ktx setup` creates `ktx.yaml` and at least one database or
|
||||
context-source connection. KTX writes local semantic sources and wiki
|
||||
context-source connection. **ktx** writes local semantic sources and wiki
|
||||
pages for agents to use before writing SQL.
|
||||
|
||||
## The build loop
|
||||
|
|
@ -34,7 +34,7 @@ ktx ingest warehouse
|
|||
ktx ingest --all
|
||||
```
|
||||
|
||||
Depth controls how much context KTX builds:
|
||||
Depth controls how much context **ktx** builds:
|
||||
|
||||
| Flag | Best for | What it does |
|
||||
|------|----------|--------------|
|
||||
|
|
@ -52,7 +52,7 @@ ktx ingest --all --deep
|
|||
Deep ingest needs LLM and embedding readiness. Otherwise run `ktx setup` or use
|
||||
`--fast`.
|
||||
|
||||
With `claude-code`, KTX agent loops can invoke only the KTX MCP tools for the
|
||||
With `claude-code`, **ktx** agent loops can invoke only the **ktx** MCP tools for the
|
||||
current run.
|
||||
|
||||
## Query history
|
||||
|
|
@ -74,7 +74,7 @@ for one run.
|
|||
|
||||
## Relationship evidence
|
||||
|
||||
KTX scores relationship candidates during supported deep database ingest. The
|
||||
**ktx** scores relationship candidates during supported deep database ingest. The
|
||||
public CLI does not expose separate relationship review subcommands.
|
||||
|
||||
## Context-source ingest
|
||||
|
|
@ -126,7 +126,7 @@ Useful flags:
|
|||
|------|-------------|
|
||||
| `--text <content>` | Capture inline text into memory; repeatable |
|
||||
| `--file <path>` | Capture a text file (or `-` for stdin) into memory; repeatable |
|
||||
| `--connection-id <connectionId>` | Attach the captured memory to a KTX connection |
|
||||
| `--connection-id <connectionId>` | Attach the captured memory to a **ktx** connection |
|
||||
| `--user-id <id>` | Attribute capture to a user scope, default `local-cli` |
|
||||
| `--json` | Print structured output |
|
||||
| `--fail-fast` | Stop after the first failed text/file item |
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: LLM configuration
|
||||
description: Configure KTX LLM providers, model roles, and prompt caching.
|
||||
description: Configure ktx LLM providers, model roles, and prompt caching.
|
||||
---
|
||||
|
||||
Configure text generation, structured extraction, and ingest or memory loops in
|
||||
|
|
@ -15,7 +15,7 @@ Set `llm.provider.backend` to one of these values:
|
|||
- `vertex`: Use Vertex AI Anthropic models through Google Cloud credentials.
|
||||
- `gateway`: Use AI Gateway-compatible Anthropic model ids.
|
||||
- `claude-code`: Use your local Claude Code session through the Claude Agent
|
||||
SDK. KTX strips provider-routing environment variables from child processes.
|
||||
SDK. **ktx** strips provider-routing environment variables from child processes.
|
||||
|
||||
## Claude Code
|
||||
|
||||
|
|
@ -40,11 +40,11 @@ During setup, choose the backend interactively or pass the model in automation:
|
|||
ktx setup --llm-backend claude-code --llm-model opus --no-input
|
||||
```
|
||||
|
||||
For Claude Code, `sonnet`, `opus`, and `haiku` map to KTX defaults. Full Claude
|
||||
For Claude Code, `sonnet`, `opus`, and `haiku` map to **ktx** defaults. Full Claude
|
||||
model IDs are also accepted.
|
||||
|
||||
`claude-code` exposes only KTX MCP tools for the current agent loop. SDK init
|
||||
metadata may still list host slash commands, skills, and subagents; KTX does not
|
||||
`claude-code` exposes only **ktx** MCP tools for the current agent loop. SDK init
|
||||
metadata may still list host slash commands, skills, and subagents; **ktx** does not
|
||||
grant execution access to them.
|
||||
|
||||
## Prompt caching
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
---
|
||||
title: Serving Agents
|
||||
description: Expose KTX context to Claude Code, Codex, Cursor, OpenCode, and custom agents.
|
||||
description: Expose ktx context to Claude Code, Codex, Cursor, OpenCode, and custom agents.
|
||||
---
|
||||
|
||||
KTX serves agents through the CLI and project-local instruction files. Agents
|
||||
read generated rules, call KTX commands, inspect context files, and use JSON for
|
||||
**ktx** serves agents through the CLI and project-local instruction files. Agents
|
||||
read generated rules, call **ktx** commands, inspect context files, and use JSON for
|
||||
structured results.
|
||||
|
||||
## Recommended setup
|
||||
|
||||
Run the agent install step from a KTX project:
|
||||
Run the agent install step from a ktx project:
|
||||
|
||||
```bash
|
||||
ktx setup --agents
|
||||
|
|
@ -44,7 +44,7 @@ Installed files are recorded in `.ktx/agents/install-manifest.json`. Rerun
|
|||
## Agent command set
|
||||
|
||||
All supported clients use the same command surface. Use `--project-dir` outside
|
||||
the KTX project directory.
|
||||
the **ktx** project directory.
|
||||
|
||||
### Readiness
|
||||
|
||||
|
|
@ -122,7 +122,7 @@ Use `--deep` only when LLM and embedding setup is ready.
|
|||
|
||||
Agents should:
|
||||
|
||||
- Run `ktx status --json` before using KTX context.
|
||||
- Run `ktx status --json` before using **ktx** context.
|
||||
- Use `ktx sl <query>` and `ktx wiki <query>` before writing SQL from memory.
|
||||
- Inspect the relevant YAML or Markdown files after search returns candidates.
|
||||
- Compile SQL with `ktx sl query --format sql` before executing.
|
||||
|
|
@ -130,7 +130,7 @@ Agents should:
|
|||
- Validate edited semantic sources with `ktx sl validate`.
|
||||
- Keep generated context changes reviewable in git.
|
||||
|
||||
KTX is a local context layer with a CLI and plain project files. Do not assume a
|
||||
**ktx** is a local context layer with a CLI and plain project files. Do not assume a
|
||||
background server, ORPC route, frontend app, or external migration system.
|
||||
|
||||
## Manual setup
|
||||
|
|
@ -144,7 +144,7 @@ Use manual setup for custom agents that can read project-local instructions.
|
|||
```
|
||||
|
||||
2. Configure the agent to read `.agents/skills/ktx/SKILL.md`.
|
||||
3. Open the agent in the KTX project directory.
|
||||
3. Open the agent in the **ktx** project directory.
|
||||
4. Ask it to run `ktx status --json` and summarize readiness.
|
||||
|
||||
For per-client notes, see [Agent Clients](/docs/integrations/agent-clients).
|
||||
|
|
@ -153,8 +153,8 @@ For per-client notes, see [Agent Clients](/docs/integrations/agent-clients).
|
|||
|
||||
| Symptom | Likely cause | Recovery |
|
||||
|---------|--------------|----------|
|
||||
| Agent says KTX is unavailable | Agent did not load the generated instruction file | Rerun `ktx setup --agents --target <target>` and restart the agent session |
|
||||
| Agent command cannot find the project | Agent is running outside the KTX directory | Add `--project-dir <path>` or open the agent in the project root |
|
||||
| Agent says **ktx** is unavailable | Agent did not load the generated instruction file | Rerun `ktx setup --agents --target <target>` and restart the agent session |
|
||||
| Agent command cannot find the project | Agent is running outside the **ktx** directory | Add `--project-dir <path>` or open the agent in the project root |
|
||||
| Generated rules point at a missing CLI path | CLI was moved, rebuilt, or reinstalled | Rerun `ktx setup --agents` |
|
||||
| Agent cannot find a metric | Context is missing or stale | Run `ktx sl <query>`, inspect source YAML, then refresh with `ktx ingest` if needed |
|
||||
| Agent query returns too many rows | The command executed without a result cap | Require `--max-rows` for executed queries |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue