scaccogatto/okf-skills
The OKF toolkit for Claude Code — author, maintain, validate & visualize Open Knowledge Format bundles. Plugin, agent skills, and a GitHub Action.
📚 okf‑skills – Claude Code plugin & skill set for the Open Knowledge Format (OKF)
What it is – A small open‑source toolkit that lets Claude‑based coding agents (Claude Code, Cursor, Codex, etc.) produce, validate, maintain and visualise knowledge bundles written in the Open Knowledge Format (OKF) v0.2. The repo ships three Claude Code skills (okf, validate, visualize), a Claude marketplace plugin, a GitHub Action for CI gating, and a self‑contained HTML graph renderer.
Why it matters – OKF is a new Google‑announced, vendor‑neutral way to store structured knowledge as plain‑text markdown files with YAML front‑matter. By integrating the spec directly into Claude’s workflow, developers can keep documentation, design decisions, metrics, etc. in a format that agents can read, update and reason over, while still being human‑editable and version‑controlled.
Key components
| Component | Role |
|---|---|
/okf:okf skill |
Generates or updates an OK‑OKF bundle from prompts (e.g. “document the auth service in OKF”). |
/okf:validate skill |
Runs a deterministic conformance checker against the OKF v0.2 spec (strict mode can fail the build). |
/okf:visualize skill |
Turns a bundle into viz.html, an interactive, backend‑free graph where each node shows rendered markdown, trust tier, staleness, provenance and backlinks. |
action.yml |
Composite GitHub Action that can be added to any repo to automatically validate a bundle in CI, even without Claude installed. |
templates/CLAUDE‑okf.md |
Snippet that, when added to a project’s CLAUDE.md, makes Claude automatically consume the bundle before tasks and write back updates after changes. |
.okf/ directory (self‑documented) |
Example bundle used for the live demo and for dog‑fooding the validator/visualiser. |
Installation & quick start
# As a Claude Code marketplace plugin
/plugin marketplace add scaccogatto/okf-skills
/plugin install okf@scaccogatto
# Or as a generic Claude skill via skills.sh (works for Cursor, Codex, etc.)
npx skills add scaccogatto/okf-skills
Local development – clone the repo and point Claude to it with claude --plugin-dir /path/to/okf-skills.
Typical workflow
- Create / update a bundle:
/okf:okf produce .okf # Claude writes markdown files under .okf - Validate before committing:
(Can also be run in CI via the provided GitHub Action.)/okf:validate .okf --strict # fails on any spec violation - Visualise the knowledge graph:
Open/okf:visualize .okf -o viz.html --title "My project" --link "https://github.com/me/project"viz.htmlin any browser – no server needed. Nodes are deep‑linkable (viz.html#services/auth-api). - Keep it fresh – add
upkeep: enforcedto.okf/index.mdto make Claude block a task if the bundle wasn’t updated, or use the soft‑mode snippet inCLAUDE‑okf.mdfor automatic background updates.
How it works under the hood
- Spec‑driven – The repository vendors the full OKF v0.2 spec (
skills/okf/reference/SPEC.md). All skills read this file to ensure deterministic behaviour. - Zero‑config Python scripts – Validation and visualisation are pure Python scripts (
okf_validate.py,okf_visualize.py) that run withuv(or plainpython3+pyyaml). No external services are required. - Self‑contained graph – The visualiser builds a single HTML file that embeds the markdown, computed trust tier, staleness badge and backlink data. Everything is computed client‑side, so the demo page never sends data anywhere.
- GitHub Action –
action.ymlwraps the validator script, exposingbundleandstrict/max-warningsinputs, allowing any repo (even without Claude) to enforce OKF compliance.
Who might use this
- Teams that already use Claude Code and want a structured, version‑controlled knowledge base that agents can read/write.
- DevOps / documentation engineers looking to gate knowledge‑bundle quality in CI.
- Researchers or product groups experimenting with AI‑augmented documentation pipelines.
License & credits
- Code and content: MIT License © Marco Boffo (@scaccogatto).
- OKF specification: Apache‑2.0, vendored from Google Cloud’s Knowledge Catalog repository with attribution.
Quick links
- Live demo – https://scaccogatto.github.io/okf-skills/
- OKF spec (v0.2) –
skills/okf/reference/SPEC.md - GitHub Action –
action.yml - Installation commands – see the Installation section above.
Related
- Project
- Project
- Project
- Project
- Project