okf

Site  ·  Docs  ·  Live demo  ·  Claude plugin  ·  Docker image

okf-gem (okf on RubyGems) is the complete harness for Open Knowledge Format (OKF) v0.1 bundles: create, maintain, and consume your project's knowledge with your agent. The package is Agent Skill + CLI/Lib + Graph: an agent skill that authors and curates, a CLI and Ruby library that validate, lint, search, and embed, and a graph to explore, live or static, in one gem that runs 100% local. A bundle is a directory of Markdown files with YAML frontmatter that humans and agents read from one source; each file is a concept. The gem does not define a new place to keep knowledge; it gives you leverage over knowledge that already lives as Markdown.

The package, end to end:

Over a bundle the gem gives you the okf command-line tool (the library API is also usable in-process). Each capability below links to the concept that documents it: this gem's own knowledge is an OKF bundle, so you can read its design in the format it defends.

Capability	What it answers	Verb
Companion agent skill	Can an agent author it?	skill
Conformance validator	Is this a legal OKF bundle? (§9)	validate
Curation linter	Is it navigable, complete, fresh?	lint / loose
Ranked text search	Which concept covers X?	search
Interactive graph server	Can I explore it visually?	server
Static render	Can I ship a serverless snapshot?	render
Library API	Can my Ruby program use it?	in-process