You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document chat feature and polish feature descriptions in README
Add a dedicated "Interactive chat" subsection under Usage that covers
what chat is, how it differs from one-off query, the session
management flags, and where to find the slash commands. Add the
`openkb chat` row to the Commands table, add a chat step in the
Quick start (replacing the lint step, which was already covered by
its own bullet), and surface chat as its own feature bullet.
While there, polish a few of the existing feature bullets: rename
"Any format" to "Broad format support" to avoid overclaiming,
tighten the "Auto wiki" bullet into "Compiled Wiki" with a single
sentence that ends on the "kept in sync" value prop, and tag the
"Query" bullet as one-off so it reads in contrast to chat.
Copy file name to clipboardExpand all lines: README.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,12 @@ Traditional RAG rediscovers knowledge from scratch on every query. Nothing accum
24
24
25
25
### Features
26
26
27
-
-**Any format** — PDF, Word, PowerPoint, Excel, HTML, Markdown, text, CSV, and more via markitdown
27
+
-**Broad format support** — PDF, Word, Markdown, PowerPoint, HTML, Excel, CSV, text, and more via markitdown
28
28
-**Scale to long documents** — Long and complex documents are handled via [PageIndex](https://github.com/VectifyAI/PageIndex) tree indexing, enabling accurate, vectorless long-context retrieval
29
29
-**Native multi-modality** — Retrieves and understands figures, tables, and images, not just text
30
-
-**Auto wiki** — LLM generates summaries, concept pages, and cross-links. You curate sources; the LLM does the rest
31
-
-**Query** — Ask questions against your wiki. The LLM navigates your compiled knowledge to answer
30
+
-**Compiled Wiki** — LLM manages and compiles your documents into summaries, concept pages, and cross-links, all kept in sync
31
+
-**Query** — Ask questions (one-off) against your wiki. The LLM navigates your compiled knowledge to answer
32
+
-**Interactive Chat** — Multi-turn conversations with persisted sessions you can resume across runs
32
33
-**Lint** — Health checks find contradictions, gaps, orphans, and stale content
33
34
-**Watch mode** — Drop files into `raw/`, wiki updates automatically
34
35
-**Obsidian compatible** — Wiki is plain `.md` files with `[[wikilinks]]`. Open in Obsidian for graph view and browsing
@@ -55,11 +56,11 @@ openkb add paper.pdf
55
56
openkb add ~/papers/ # Add a whole directory
56
57
openkb add article.html
57
58
58
-
# 4. Ask questions
59
+
# 4. Ask a question
59
60
openkb query "What are the main findings?"
60
61
61
-
# 5. Check wiki health
62
-
openkb lint
62
+
# 5. Or start an interactive chat session
63
+
openkb chat
63
64
```
64
65
65
66
### Set up your LLM
@@ -132,13 +133,28 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
132
133
|`openkb add <file_or_dir>`| Add documents and compile to wiki |
133
134
|`openkb query "question"`| Ask a question against the knowledge base |
134
135
|`openkb query "question" --save`| Ask and save the answer to `wiki/explorations/`|
136
+
|`openkb chat`| Start an interactive multi-turn chat (use `--resume`, `--list`, `--delete` to manage sessions) |
135
137
|`openkb watch`| Watch `raw/` and auto-compile new files |
136
138
|`openkb lint`| Run structural + knowledge health checks |
137
139
|`openkb list`| List indexed documents and concepts |
138
140
|`openkb status`| Show knowledge base stats |
139
141
140
142
<!-- | `openkb lint --fix` | Auto-fix what it can | -->
141
143
144
+
### Interactive chat
145
+
146
+
`openkb chat` opens an interactive chat session over your wiki knowledge base. Unlike the one-shot `openkb query`, each turn carries the conversation history, so you can dig into a topic without re-typing context.
147
+
148
+
```bash
149
+
openkb chat # start a new session
150
+
openkb chat --resume # resume the most recent session
151
+
openkb chat --resume 20260411 # resume by id (unique prefix works)
152
+
openkb chat --list # list all sessions
153
+
openkb chat --delete <id># delete a session
154
+
```
155
+
156
+
`/help` lists all slash commands: e.g., `/save` exports the transcript, `/clear` starts a fresh session.
157
+
142
158
### Configuration
143
159
144
160
Settings are initialized by `openkb init`, and stored in `.openkb/config.yaml`:
0 commit comments