okf
okf is a toolkit for building and updating knowledge bundles as directories of markdown files with YAML frontmatter. Create bundles to capture project knowledge like APIs, schemas, and runbooks, maintain them as code and docs evolve, or consume existing bundles to inform your work. The skill enforces the OKF v0.2 spec: every markdown file needs a type field, and everything else follows soft conventions for cross-linking, provenance, and lifecycle tracking.
okf lets you create and maintain portable knowledge bundles as markdown files with YAML frontmatter that both humans and agents can read.
AI-generated summary based on this skill's SKILL.md
Install
scaccogatto/okf-skills/okf · repository language: Python
git clone https://github.com/scaccogatto/okf-skills
cp -r okf-skills/skills/okf ~/.claude/skills/okfFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I create OKF knowledge bundles?
okf provides a toolkit for building knowledge bundles as directories of markdown files with YAML frontmatter. Start by organizing your project knowledge—APIs, schemas, runbooks, decisions—into a .okf directory. Each markdown file requires a type field in its YAML frontmatter to conform to the OKF v0.2 specification. okf enforces this structure and helps you maintain bundles as your code and documentation evolve.
What is the open knowledge format markdown yaml structure?
okf bundles use markdown files paired with YAML frontmatter to create portable knowledge. The OKF v0.2 spec requires every file to include a type field in its frontmatter; other fields follow soft conventions for cross-linking, provenance, and lifecycle tracking. This markdown + YAML approach lets you treat knowledge as code, versioning and updating it alongside your project.
How do I validate OKF bundle conformance to v0.2 specification?
okf includes validation tooling to check your bundle against the OKF v0.2 specification. The primary requirement is that every markdown file in your .okf directory contains a type field in its YAML frontmatter. okf validates this conformance and helps you identify missing or malformed frontmatter so your bundle stays compliant as you add and update knowledge files.
Can I consume OKF knowledge in agent-driven tasks?
Yes. okf supports a consume mode that lets agents and workflows use existing knowledge bundles as context for their work. Once your bundle is validated and structured, you can feed it into agent-driven tasks to inform decisions, automate documentation, or guide runbook execution. This bridges the gap between static knowledge capture and dynamic task execution.
How do I migrate v0.1 OKF bundles to v0.2?
okf provides migration support for legacy v0.1 bundles. The primary change in v0.2 is the requirement for a type field in every markdown file's YAML frontmatter. okf can help you update your .okf directory structure and frontmatter to meet the current specification, ensuring your older bundles work with the latest tooling.
What are okf's produce, maintain, and consume modes?
okf operates in three modes: produce (create and build new knowledge bundles), maintain (update bundles as code and docs change), and consume (use bundles as context for agent tasks). Together, these modes support the full lifecycle of knowledge as code—from initial capture through ongoing evolution to active use in workflows.
SKILL.md
rendered from the published skill — quoted content, verbatim
Open Knowledge Format (OKF) skill
OKF represents knowledge as a directory of markdown files with YAML frontmatter. It is minimal by design: no schema registry, no runtime, no SDK. Your job is to produce, maintain, and consume OKF bundles conformant with the spec, not your memory of it.
Always read the canonical spec before non-trivial work: reference/SPEC.md. It is the verbatim OKF v0.2 specification and the source of truth for every rule below.
The
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 7 files
skills/okf/SKILL.md
skills/okf/reference/APACHE-2.0.txt
skills/okf/reference/SPEC.md
skills/okf/scripts/okf_init.py
skills/okf/templates/concept.md
skills/okf/templates/index.md
skills/okf/templates/log.md