Open Knowledge CLI

Flexible knowledge bases in Markdown that your agents can create, retrieve, maintain, validate, and publish.

Get started

curl -fsSL https://openknowledge.sh/install | bash
okn setup
okn check Wiki
okn search Wiki "release workflow"
okn view Wiki

Setup creates a managed copy of existing Markdown or adopts one directory. Existing Markdown does not require an agent, frontmatter, or authored links. If no Markdown exists, setup creates an agent task. Complete that task before the checks. Replace Wiki with your selected target path.

This documentation uses okn as the preferred command. The full openknowledge command remains available.

The published documentation is at openknowledge.sh/wiki. It is the exported version of this OKF wiki.

Workflows

Start here

Use setup to create or adopt a knowledge base. Use check to get one health status. Use search to retrieve knowledge. Use view to browse the knowledge base.

Use validate for detailed format and link diagnostics. Use review for an optional agent review. Use upgrade for OKF format changes.

Trust and govern

Use the trusted intent when you need source, evidence, lifecycle, and conflict controls. Use audit, claims, and evidence to apply these controls. Use eval and quality to measure results.

Query and interchange

Use query for explicit semantic queries. Use export to create portable output.

Publish and operate

Use publish to build configured output after checks permit publication. Use mcp to serve MCP tools. Use connect and registry to manage sources. Use automation for managed processes.

Knowledge CI and the production runtime are optional. See the Knowledge CI Golden Path when you need these capabilities.

Advanced internals

Use agent to run an agent task. Use get and list for direct inspection. Other tools include scaffold, prompt, ast, and spec.

Claims