From 9779a130e0e1325e1a437cf1545bfa07613fc431 Mon Sep 17 00:00:00 2001 From: Ray Date: Wed, 15 Jul 2026 19:23:06 +0800 Subject: [PATCH 1/5] update readme --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 68fe6c17..bbd62e24 100644 --- a/README.md +++ b/README.md @@ -204,9 +204,6 @@ Inside `openkb chat`, type `/` for slash commands (Tab to complete): | `/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) | From 97660f85ed363d3d4bd7e5239b859f43ed39aa24 Mon Sep 17 00:00:00 2001 From: Ray Date: Wed, 15 Jul 2026 21:01:45 +0800 Subject: [PATCH 2/5] update readme --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bbd62e24..8411c7cd 100644 --- a/README.md +++ b/README.md @@ -191,22 +191,21 @@ A "generator" reads from the compiled wiki and produces something usable: an ans `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): +Inside a chat, type `/` to access slash commands (Tab to complete).
-Slash commands: +More slash commands:
-| Command | Does | -|---|---| -| `/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/` | -| `/lint` | Run knowledge base lint | -| `/clear` | Start a fresh session (the current one stays on disk) | -| `/exit` | Exit (`/quit` or Ctrl-D also work) | +- `/help`: list available commands +- `/status`: show knowledge base status +- `/list`: list all documents +- `/add `: add a document or directory without leaving the chat +- `/skill new ""`: compile a skill from this chat (see below) +- `/save [name]`: export the transcript to `wiki/explorations/` +- `/clear`: start a fresh session (the current one stays on disk) +- `/lint`: run knowledge base lint +- `/exit`: exit (Ctrl-D also works)
From df4d4a8a78bd7bc129ec0077971b59ad111e3df0 Mon Sep 17 00:00:00 2001 From: Ray Date: Wed, 15 Jul 2026 21:09:25 +0800 Subject: [PATCH 3/5] update readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8411c7cd..af2a3ed3 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ openkb deck new my-deck "An intro deck on " # slides OpenKB supports [multiple LLM providers](https://docs.litellm.ai/docs/providers) (OpenAI, Claude, Gemini, etc.) via [LiteLLM](https://github.com/BerriAI/litellm) (pinned to a [safe version](https://docs.litellm.ai/blog/security-update-march-2026)). -Set your model during `openkb init` or in [`.openkb/config.yaml`](#configuration) using the `provider/model` LiteLLM format (e.g. `anthropic/claude-sonnet-4-6`). OpenAI models can omit the prefix (e.g. `gpt-5.4`). +Set your model during `openkb init` or in [`.openkb/config.yaml`](#configuration) using the `provider/model` LiteLLM format (e.g. `anthropic/claude-sonnet-4-6`, `gemini/gemini-3.1-pro-preview`). OpenAI models can omit the prefix (e.g. `gpt-5.4`). Create a `.env` file with your LLM API key: @@ -115,6 +115,8 @@ Create a `.env` file with your LLM API key: LLM_API_KEY=your_llm_api_key ``` +Subscription-based providers that authenticate via OAuth device flow (e.g. `chatgpt/*`, `github_copilot/*`) need no API key; OpenKB skips the missing-key warning for them. + # 🧩 How OpenKB Works ### Architecture From d91d406daa71ae6a8c8df749831114a9e30d08d6 Mon Sep 17 00:00:00 2001 From: Ray Date: Wed, 15 Jul 2026 21:37:16 +0800 Subject: [PATCH 4/5] update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index af2a3ed3..ef35e4a8 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,7 @@ 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* +### (i) 💬 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). @@ -213,7 +213,7 @@ Inside a chat, type `/` to access slash commands (Tab to complete). -### 🛠 Skill Factory — *drop in a book; out comes a digital expert.* +### (ii) 🛠 Skill Factory — *drop in a book; out comes a digital expert.* `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/)**. @@ -233,7 +233,7 @@ Inside a chat, type `/` to access slash commands (Tab to complete). ### Settings -`openkb init` writes `.openkb/config.yaml`: +OpenKB settings are initialized by `openkb init` and stored in `.openkb/config.yaml`: ```yaml model: gpt-5.4 # LLM model (any LiteLLM-supported provider) From 1e7ac31d80a825dce446d14b87cf620c40ca0046 Mon Sep 17 00:00:00 2001 From: Ray Date: Wed, 15 Jul 2026 21:40:06 +0800 Subject: [PATCH 5/5] update readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ef35e4a8..e8fcda0a 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ openkb deck new my-deck "An intro deck on " # slides OpenKB supports [multiple LLM providers](https://docs.litellm.ai/docs/providers) (OpenAI, Claude, Gemini, etc.) via [LiteLLM](https://github.com/BerriAI/litellm) (pinned to a [safe version](https://docs.litellm.ai/blog/security-update-march-2026)). -Set your model during `openkb init` or in [`.openkb/config.yaml`](#configuration) using the `provider/model` LiteLLM format (e.g. `anthropic/claude-sonnet-4-6`, `gemini/gemini-3.1-pro-preview`). OpenAI models can omit the prefix (e.g. `gpt-5.4`). +Set your model during `openkb init` or in [`.openkb/config.yaml`](#configuration) using the `provider/model` LiteLLM format (e.g. `anthropic/claude-sonnet-4-6`). OpenAI models can omit the prefix (e.g. `gpt-5.4`). Create a `.env` file with your LLM API key: @@ -204,6 +204,8 @@ Inside a chat, type `/` to access slash commands (Tab to complete). - `/list`: list all documents - `/add `: add a document or directory without leaving the chat - `/skill new ""`: compile a skill from this chat (see below) +- `/deck new ""`: generate an HTML slide deck from the wiki +- `/critique `: run the HTML critic over an existing deck - `/save [name]`: export the transcript to `wiki/explorations/` - `/clear`: start a fresh session (the current one stays on disk) - `/lint`: run knowledge base lint