diff --git a/README.md b/README.md index 0fecbe11..68fe6c17 100644 --- a/README.md +++ b/README.md @@ -187,15 +187,29 @@ A "generator" reads from the compiled wiki and produces something usable: an ans | openkb skill new <skill-name> "<intent>" | Distill a redistributable agent skill from your wiki (see [Skill Factory](#skill-factory) below) | [skills](examples/skills/) | | openkb deck new <name> "<intent>" | Generate a single-file HTML slide deck (`--skill` picks a theme, `--critique` runs a quality pass) | [slides](examples/slides/) | +### 💬 Query & Chat — *ask the wiki* + +`openkb query "..."` answers a single question with a grounded, cited answer from your wiki. `openkb chat` is interactive, an ongoing multi-turn session over the same wiki (`--resume`, `--list`, `--delete` to manage sessions). → Walked through with real saved output in **[`examples/commands/`](examples/commands/)** (query) and **[`examples/chat/`](examples/chat/)** (chat). + +Inside `openkb chat`, type `/` for slash commands (Tab to complete): +
-More skill commands: +Slash commands:
-| Command | Output | +| Command | Does | |---|---| -| openkb skill validate [name] | Validate compiled skills (auto-runs after `skill new`) | -| openkb skill eval <name> | Check the skill triggers on the right prompts | -| openkb skill history <name> / openkb skill rollback <name> | Version history + rollback for skills | +| `/help` | List available commands | +| `/status` | Show knowledge base status | +| `/list` | List all documents | +| `/add ` | Add a document or directory without leaving the chat | +| `/save [name]` | Export the transcript to `wiki/explorations/` | +| `/skill new ""` | Compile a skill from this chat | +| `/deck new ""` | Generate a slide deck (`--skill` picks a theme, `--critique` runs a quality pass) | +| `/critique ` | Run a quality critique pass on a generated deck | +| `/lint` | Run knowledge base lint | +| `/clear` | Start a fresh session (the current one stays on disk) | +| `/exit` | Exit (`/quit` or Ctrl-D also work) |
@@ -203,7 +217,19 @@ A "generator" reads from the compiled wiki and produces something usable: an ans ### 🛠 Skill Factory — *drop in a book; out comes a digital expert.* -The flagship generator: `openkb skill new` distills a portable [agent skill](https://docs.claude.com/en/docs/build-with-claude/skills) from your wiki that Claude Code, Codex, and Gemini can install and load natively. Drop in a book's worth of papers; out comes a specialist other agents can call on. → A real generated skill, plus install / share / `eval` / rollback, is walked through in **[`examples/skills/`](examples/skills/)**. +`openkb skill new` distills a portable [agent skill](https://docs.claude.com/en/docs/build-with-claude/skills) from your wiki that Claude Code, Codex, and Gemini can install and load natively. Drop in a book's worth of papers; out comes a specialist other agents can call on. → A real generated skill, plus install / share / `eval` / rollback, is walked through in **[`examples/skills/`](examples/skills/)**. + +
+More skill commands: +
+ +| Command | Output | +|---|---| +| openkb skill validate [name] | Validate compiled skills (auto-runs after `skill new`) | +| openkb skill eval <name> | Check the skill triggers on the right prompts | +| openkb skill history <name> / openkb skill rollback <name> | Version history + rollback for skills | + +
# 🔧 Configuration