| type | Feature Documentation | ||||||
|---|---|---|---|---|---|---|---|
| title | Tooling Model | ||||||
| description | Product-level map of the Open Knowledge CLI workflows. | ||||||
| tags |
|
||||||
| timestamp | 2026-07-17 00:00:00 UTC |
Open Knowledge provides one lifecycle for an OKF knowledge base. Search, the viewer, MCP, agents, jobs, exports, and services use the same knowledge base. They do not use separate knowledge models.
| Workflow | Commands | Outcome |
|---|---|---|
| Start here | setup, search, validate |
Print or run wiki setup, retrieve useful context, and verify its source. |
| Work locally | agent, get, list, view |
Maintain, connect, read, and browse knowledge on the current machine. |
| Share and connect | export, mcp, connect, disconnect, registry |
Publish portable views and resolve local or remote bundles. |
| Automate and operate | automation |
Run jobs, insights, hosted runtimes, and deployments. |
okn setup prints the primary setup prompt.
The prompt uses the current directory as its source and writes Wiki.
Copy the printed prompt into an agent that already works in the project.
An explicit wiki path without --from prints a guided setup.
Use this form for a new or open-ended knowledge base.
Use --from only for a different repository, folder, or website.
scaffold is an advanced, deterministic operation without an agent.
prompt provides additional portable workflows that only print output.
Each connection change has one command.
connect materializes and registers local, manifest, archive, or Git sources.
disconnect removes the registration.
registry provides only refresh, list, status, and where.
All key-or-path consumers use the same resolver.
Thus, get, search, view, mcp, validate, list, and export use the same source rules.
These rules apply to direct folders and registered sources.
export html publishes a portable archive and manifest.
You can connect this output again.
Deterministic validation does not require a model.
okn prompt review provides advice and does not affect validation status.
Machine-readable views use versioned Draft 2020-12 contracts.
These views include AST, bundle, graph, list, registry, search, and validation output.
okn setup
okn search Wiki "release workflow" --budget 1200
okn validate WikiUse separate commands for exact reads, browsing, integrations, and publication:
okn list Wiki
okn get Wiki
okn mcp Wiki
okn view Wiki
okn export html --out ./site WikiSource anchors
packages/cli/cmd/openknowledge/main.gopackages/cli/cmd/openknowledge/setup_command.gopackages/cli/internal/okf/registry.go