2026-05-11 00:45:43 -07:00
---
title: "ktx wiki"
2026-05-14 01:43:06 +02:00
description: "List or search wiki pages."
2026-05-11 00:45:43 -07:00
---
2026-05-13 16:05:58 +02:00
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.
2026-05-11 00:45:43 -07:00
2026-05-11 16:43:08 -07:00
## Command signature
2026-05-11 00:45:43 -07:00
```bash
ktx wiki <subcommand> [options]
```
## Subcommands
| Subcommand | Description |
|-----------|-------------|
| `list` | List local wiki pages |
| `search <query>` | Search local wiki pages |
## Options
### `wiki list`
| Flag | Description | Default |
|------|-------------|---------|
2026-05-13 13:01:56 +02:00
| `--json` | Print JSON output | `false` |
2026-05-11 00:45:43 -07:00
| `--user-id <id>` | Local user id | `local` |
### `wiki search`
| Flag | Description | Default |
|------|-------------|---------|
2026-05-13 13:01:56 +02:00
| `--json` | Print JSON output | `false` |
2026-05-11 00:45:43 -07:00
| `--user-id <id>` | Local user id | `local` |
2026-05-13 13:01:56 +02:00
| `--limit <number>` | Maximum search results | — |
2026-05-11 00:45:43 -07:00
## Examples
```bash
# List all wiki pages
ktx wiki list
2026-05-13 13:01:56 +02:00
# List all wiki pages as JSON
ktx wiki list --json
2026-05-11 00:45:43 -07:00
# Search wiki pages
ktx wiki search "monthly recurring revenue"
2026-05-13 13:01:56 +02:00
# Search wiki pages as JSON
ktx wiki search "monthly recurring revenue" --json --limit 10
2026-05-11 00:45:43 -07:00
```
2026-05-11 16:43:08 -07:00
## Output
2026-05-14 01:43:06 +02:00
Wiki commands print local wiki page listings and search results. Open the
matching Markdown files directly when you need the full page contents.
2026-05-11 16:43:08 -07:00
```json
{
2026-05-13 13:01:56 +02:00
"kind": "list",
"data": {
"items": [
{
"key": "revenue-definitions",
"summary": "Canonical revenue metric definitions",
"score": 0.92
}
]
}
2026-05-11 16:43:08 -07:00
}
```
## Common errors
| Error | Cause | Recovery |
|-------|-------|----------|
2026-05-13 16:05:58 +02:00
| 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 |
2026-05-14 01:43:06 +02:00
| A page is missing | No Markdown file exists for that business context | Add a file under `wiki/` or run `ktx ingest <connectionId>` |