Everything the gem does,
and the format underneath it
The Open Knowledge Format is a documentation format for LLMs and the humans beside them: a directory of Markdown files with YAML frontmatter, versioned in git, read from the same source by both. okf-gem is the toolkit for it, an agent skill, a CLI, and a live knowledge graph. These docs cover all of it, spec included.
Start in three steps
Install the gem
Runs on every Ruby since 2.4, with three dependencies.
$ gem install okf Check a directory
Any folder of Markdown with frontmatter is close to a bundle already.
$ okf validate docs/ See the graph
Your knowledge as an interactive graph, in the browser.
$ okf server docs/ What do you need to do?
Understand the system
The agent skillHow a coding agent becomes an OKF expert: three lenses, six verbs, one flywheel. Why OKFThe problem of homeless project knowledge, and how a bundle in git solves it. Bundle anatomyConcepts, frontmatter, cross-links, index.md, log.md, and the graph that emerges. The OKF v0.1 specThe full specification, as shipped inside the gem. Conformance vs curationLegal is validate's question; well-curated is lint's. Why the split matters. Claude Code pluginThe skill, /okf:gem, and a deterministic curation hook, installed in two commands.
All pages
CLI · read
CLI · serve & setup
Reference
Project