mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
d7147f9ca1
* feat: rename project wiki directory * test: fix wiki skill ordering expectations * Show configured context sources in setup
133 lines
3.9 KiB
Text
133 lines
3.9 KiB
Text
---
|
|
title: "ktx wiki"
|
|
description: "List, read, search, or write wiki pages."
|
|
---
|
|
|
|
Manage wiki pages in your KTX project. Wiki pages are Markdown documents that capture business definitions, rules, and gotchas. Agents search them for context when answering questions about your data.
|
|
|
|
## Command signature
|
|
|
|
```bash
|
|
ktx wiki <subcommand> [options]
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
| Subcommand | Description |
|
|
|-----------|-------------|
|
|
| `list` | List local wiki pages |
|
|
| `read <key>` | Read one local wiki page |
|
|
| `search <query>` | Search local wiki pages |
|
|
| `write <key>` | Write one local wiki page |
|
|
|
|
## Options
|
|
|
|
### `wiki list`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--user-id <id>` | Local user id | `local` |
|
|
|
|
### `wiki read`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--user-id <id>` | Local user id | `local` |
|
|
|
|
### `wiki search`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--user-id <id>` | Local user id | `local` |
|
|
| `--limit <number>` | Maximum search results | — |
|
|
|
|
### `wiki write`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--user-id <id>` | Local user id | `local` |
|
|
| `--scope <scope>` | Scope: `global` or `user` | `global` |
|
|
| `--summary <summary>` | Wiki page summary (required) | — |
|
|
| `--content <content>` | Wiki page content (required) | — |
|
|
| `--tag <tag>` | Wiki tag; repeatable | — |
|
|
| `--ref <ref>` | Wiki ref; repeatable | — |
|
|
| `--sl-ref <ref>` | Semantic-layer ref; repeatable | — |
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
# List all wiki pages
|
|
ktx wiki list
|
|
|
|
# List all wiki pages as JSON
|
|
ktx wiki list --json
|
|
|
|
# Read a specific wiki page
|
|
ktx wiki read revenue-definitions
|
|
|
|
# Read a specific wiki page as JSON
|
|
ktx wiki read revenue-definitions --json
|
|
|
|
# Search wiki pages
|
|
ktx wiki search "monthly recurring revenue"
|
|
|
|
# Search wiki pages as JSON
|
|
ktx wiki search "monthly recurring revenue" --json --limit 10
|
|
|
|
# Write a global wiki page
|
|
ktx wiki write revenue-definitions \
|
|
--summary "Canonical revenue metric definitions" \
|
|
--content "## MRR\nMonthly Recurring Revenue is calculated as..."
|
|
|
|
# Write a user-scoped wiki page
|
|
ktx wiki write my-notes \
|
|
--scope user \
|
|
--summary "Personal analysis notes" \
|
|
--content "Things to check when revenue numbers look off..."
|
|
|
|
# Write a page with tags and references
|
|
ktx wiki write churn-rules \
|
|
--summary "Churn calculation business rules" \
|
|
--content "A customer is considered churned when..." \
|
|
--tag finance \
|
|
--tag retention \
|
|
--sl-ref customers \
|
|
--sl-ref subscriptions
|
|
|
|
# Write a page with external references
|
|
ktx wiki write data-freshness \
|
|
--summary "Data pipeline SLAs and freshness guarantees" \
|
|
--content "The orders table refreshes every 15 minutes..." \
|
|
--ref "https://wiki.example.com/data-pipelines"
|
|
```
|
|
|
|
## Output
|
|
|
|
Wiki commands print local wiki pages and search results. Agents should search first, then read the most relevant page by key.
|
|
|
|
```json
|
|
{
|
|
"kind": "list",
|
|
"data": {
|
|
"items": [
|
|
{
|
|
"key": "revenue-definitions",
|
|
"summary": "Canonical revenue metric definitions",
|
|
"score": 0.92
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Common errors
|
|
|
|
| Error | Cause | Recovery |
|
|
|-------|-------|----------|
|
|
| Search returns no results | The query terms do not match summaries, tags, or content | Retry with business synonyms, then create a page if the knowledge is missing |
|
|
| Read fails for a key | The page key is wrong or scoped to a different user | Run `ktx wiki list` or search again to get the exact key |
|
|
| Write fails due to missing fields | `--summary` or `--content` was omitted | Pass both fields, and keep the summary short enough for search results |
|
|
| Agent writes duplicate pages | It did not search existing pages first | Always run `ktx wiki search` before `ktx wiki write` |
|