okf

okf — a harness for the Open Knowledge Format

okf works with directories of Markdown knowledge: create and query concepts, follow relationships, track source changes, and maintain documentation with explicit review evidence. It provides readable CLI output for people and NDJSON for programs and agents. Agent skills supply the judgment around its deterministic operations.

The knowledge bundle is the user manual, CLI reference, contributor guide, and a working example of OKF. Tour the bundle to query its real relationships, inspect artifacts, and trace source impact.

Install

Breaking change in CLI 0.5.0: read the migration guide before updating a 0.4.x installation or automation. Install CLI and plugin together; the 0.5.2 plugin supports stable CLI versions >=0.5.0, <0.6.0. The document format remains OKF v0.2.

Download the installer from the published release, inspect it, then run it:

curl --fail --location --proto '=https' --proto-redir '=https' \
  https://github.com/briareus-io/okf/releases/download/v0.5.2/install.sh -o install.sh
# Review install.sh before running it.
sh install.sh 0.5.2
export PATH="$HOME/.local/bin:$PATH"
okf version

See installation for archive downloads, checksum verification, supported platforms, and updates. See agent plugins for Claude Code and Codex setup.

Try it

Run in a scratch directory. Explicit bundle paths keep the example independent of local settings.

okf init mybundle
okf add notes/hello mybundle --type Note --title "Hello" --description "A first note" --body "Hello from OKF."
okf search mybundle --text Hello
okf show notes/hello mybundle
okf validate mybundle

Find your next step

• Getting started: installation and your first bundle.
• Task guides: retrieve, model, maintain, reorganize, and automate.
• Concepts: provenance, verification, ontology, and scope.
• CLI commands and shared reference.
• Agent workflows: choose the skill for your task.
• Contributing: development, architecture, decisions, and releases.