Skip to content

Commit 04ab3bc

Browse files
committed
docs(readme): document openkb visualize
Add it to the Layer 2 generators table and a '(iii) Visualize' subsection matching the existing (i)/(ii) generator sections: a self-contained interactive knowledge graph (3D / mind-map / radial) written to output/visualize/graph.html.
1 parent 9b2788b commit 04ab3bc

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ A "generator" reads from the compiled wiki and produces something usable: an ans
206206
|---|---|
207207
| <code>openkb&nbsp;query&nbsp;"question"</code> | A grounded answer with citations (`--save` to persist to `wiki/explorations/`) |
208208
| <code>openkb&nbsp;chat</code> | Interactive multi-turn session over the wiki (`--resume`, `--list`, `--delete` to manage sessions) |
209+
| <code>openkb&nbsp;visualize</code> | A self-contained interactive knowledge graph at `output/visualize/graph.html` — 3D, mind-map, and radial views (`--no-open` for headless) |
209210
| | |
210211
| <code>openkb&nbsp;skill&nbsp;new&nbsp;&lt;skill-name&gt;&nbsp;"&lt;intent&gt;"</code> | Distill a redistributable agent skill from your wiki (see [Skill Factory](#-skill-factory--drop-in-a-book-out-comes-a-digital-expert) below) |
211212

@@ -339,6 +340,19 @@ openkb skill rollback karpathy-thinking --to 2
339340

340341
</details>
341342

343+
### (iii) 🗺 Visualize — *see the shape of your knowledge*
344+
345+
`openkb visualize` renders the wiki as a single self-contained HTML page — no server, no network, fully offline. It opens in your browser and ships three views of the same knowledge base:
346+
347+
- **3D** — a force-directed graph of every page, coloured by type and sized by how connected it is.
348+
- **mind-map** — an OpenKB-rooted tree (OpenKB → documents → the concepts each produced), expanded branch by branch.
349+
- **radial** — the same hierarchy fanned out in a circle, with cross-references that light up on hover.
350+
351+
```bash
352+
openkb visualize # build + open output/visualize/graph.html
353+
openkb visualize --no-open # just write the file (headless / CI)
354+
```
355+
342356
# 🔧 Configuration
343357

344358
### Settings

0 commit comments

Comments
 (0)