openknowledge

README

Open Knowledge

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

🌐 Website | 📖 Documentation | 🧭 Commands | 📝 Changelog | 📐 OKF specification | ⚖️ License

From project to knowledge base

Your project
    │
    ▼
 okn setup ──► your agent creates Wiki/
                         │
                         ▼
                  okn validate Wiki
                         │
             ┌───────────┼───────────┐
             ▼           ▼           ▼
          search        view      export html

Quick start

1. Install

curl -fsSL https://openknowledge.sh/install | bash

2. Create

okn setup

okn setup uses the current project as its source and Wiki as the default target. Run it, then copy the complete printed prompt into the agent that already works in your project.

3. Validate

When the agent finishes:

okn validate Wiki

Alternative npm installation

npm install -g @openknowledge-sh/openknowledge

Both installers provide okn and openknowledge. This documentation uses okn. See Installation for supported platforms and verification details.

Optional agent integration

okn integration install Wiki --runtime codex

This optional command installs only the selected runtime. Session observation remains off unless you explicitly add --observe.

Workflows

Create, retrieve, and verify

Use setup to print a portable setup prompt. Copy the complete output into an agent that already works in the project. Use search to retrieve knowledge. Use validate to verify the wiki.

Work locally

Use agent to run an agent task. Use integration to install one runtime skill. Use get to read one document. Use list to inspect the content tree. Use view to browse the wiki.

Share and connect

Use mcp to serve MCP tools. Use export to publish portable output. Use connect to add a source. Use disconnect to remove a source. Use registry to inspect the registry.

Automate and operate

Use automation for jobs, insights, runtime services, and deployments.

Use advanced tools

Use scaffold for deterministic bundle creation. Other advanced tools are prompt, ast, and spec.

See the command index for all commands. Use okn <command> --help for exact command syntax.

Publish a wiki

okn export html creates a public distribution bundle in a local folder. It does not deploy the bundle or start an MCP server.

Review the knowledge base before you create this bundle. After you enable publication, Markdown is public unless it sets okf_publish: false. Add this configuration to Wiki/openknowledge.toml:

[publish]
enabled = true

Export the reviewed content:

okn export html --out ./site Wiki

The bundle includes a static viewer, llms.txt, a connect manifest, and a portable source archive. A deployed runtime can also expose filtered search and HTTP MCP projections. See HTML export and openknowledge.toml for publication filters and asset options.

Development

pnpm install --frozen-lockfile
pnpm test
pnpm build

See CLI operations for focused test, build, website, and release commands.

License and attribution

Open Knowledge is licensed under Apache-2.0.

The embedded OKF specification is Apache-2.0 material from GoogleCloudPlatform/knowledge-catalog. See THIRD_PARTY_NOTICES.md for attribution.