mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
92 lines
2.5 KiB
Text
92 lines
2.5 KiB
Text
---
|
|
title: "ktx wiki"
|
|
description: "List or search wiki pages."
|
|
---
|
|
|
|
List and search 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 |
|
|
| `search <query>` | Search local wiki pages |
|
|
|
|
The current public CLI lists and searches wiki pages. Edit the Markdown files
|
|
under `wiki/` directly, or ingest source content with `ktx ingest`, when you
|
|
need to add or update wiki knowledge.
|
|
|
|
## Options
|
|
|
|
### `wiki list`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--user-id <id>` | Local user id | `local` |
|
|
| `--output <mode>` | Output mode: `pretty` (default in TTY), `plain` (TSV), or `json` | `pretty` |
|
|
| `--json` | Shortcut for `--output=json` (overrides `--output`) | `false` |
|
|
|
|
### `wiki search`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--user-id <id>` | Local user id | `local` |
|
|
| `--limit <number>` | Maximum search results | - |
|
|
| `--output <mode>` | Output mode: `pretty` (default in TTY), `plain` (TSV), or `json` | `pretty` |
|
|
| `--json` | Shortcut for `--output=json` (overrides `--output`) | `false` |
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
# List all wiki pages
|
|
ktx wiki list
|
|
|
|
# List all wiki pages as JSON
|
|
ktx wiki list --json
|
|
|
|
# Search wiki pages
|
|
ktx wiki search "monthly recurring revenue"
|
|
|
|
# Search wiki pages as JSON
|
|
ktx wiki search "monthly recurring revenue" --json --limit 10
|
|
|
|
# Print search results as TSV
|
|
ktx wiki search "monthly recurring revenue" --output plain
|
|
```
|
|
|
|
## Output
|
|
|
|
Wiki commands print clack-style pretty output in a TTY and TSV-style plain
|
|
output when requested. JSON output wraps the items with a command metadata
|
|
envelope. Open the matching Markdown files directly when you need the full page
|
|
contents.
|
|
|
|
```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 |
|
|
| A page is missing | No Markdown file exists for that business context | Add a file under `wiki/` or run `ktx ingest <connectionId>` |
|