Repolode
scaccogatto

scaccogatto/okf-skills

A Claude Code toolkit for authoring, validating, visualizing and maintaining OKF (Open Knowledge Format) markdown knowledge bundles.

Stars
442
Forks
42
Open issues
7
Last commit
3 days ago

What is it?

OKF is an open, vendor-neutral format for storing knowledge about a system as a directory of markdown files with YAML frontmatter. This project gives Claude Code the ability to produce, maintain, consume, validate and visualize OKF bundles as part of its normal workflow. It includes a deterministic conformance checker for the spec, a viz script that renders a bundle as an interactive graph, and a backfill skill that reconstructs a bundle from git history and session transcripts.

The toolkit ships through several channels: a Claude Code plugin, agent skills installable via skills.sh, a GitHub Action that validates bundles in CI without an agent, and a read-only MCP server with search, read and neighbor-lookup tools. Version 0.2 of the format adds provenance, trust and staleness fields, which the tools read and can migrate from v0.1.

The repository is MIT licensed and includes the vendored OKF v0.2 spec, a sample bundle behind a live demo, and benchmark experiments with their protocols and results.

Key features

  • 01Generates and maintains OKF knowledge bundles from the vendored spec and templates.
  • 02Validates bundles against the spec with strict and warning-threshold modes, plus JSON output.
  • 03Renders a bundle as a self-contained interactive HTML graph with trust and staleness badges.
  • 04Backfills a bundle from git history and Claude session transcripts.
  • 05Provides a read-only MCP server exposing search, read and neighbor tools.
  • 06Includes a GitHub Action for validating bundles in CI.

Use cases

  • Documenting a service's architecture and decisions as versioned markdown alongside the code.
  • Giving coding agents structured project context they can read and cite.
  • Validating knowledge bundles automatically in CI before merging.
  • Reconstructing project documentation for a repository that has no existing bundle.

Quick start

  1. 1

    Add the marketplace in Claude Code

    /plugin marketplace add scaccogatto/okf-skills
  2. 2

    Install the okf plugin

    /plugin install okf@scaccogatto
  3. 3

    Document a project in OKF by asking Claude to produce a bundle

    /okf:okf produce .okf
  4. 4

    Validate the bundle before committing

    /okf:validate .okf --strict

Things to know

  • The full toolchain is built for Claude Code; other agents get only the skills, without backfill subagents.
  • The scripts need uv or python3 with pyyaml installed.
  • The project is pre-1.0, so the @v1 action tag may change between releases.

In collections

Topics

FAQ

What is okf-skills?
A Claude Code toolkit for authoring, validating, visualizing and maintaining OKF (Open Knowledge Format) markdown knowledge bundles. OKF is an open, vendor-neutral format for storing knowledge about a system as a directory of markdown files with YAML frontmatter. This project gives Claude Code the ability to produce, maintain, consume, validate and visualize OKF bundles as part of its normal workflow. It includes a deterministic conformance checker for the spec, a viz script that renders a bundle as an interactive graph, and a backfill skill that reconstructs a bundle from git history and session transcripts.
Is okf-skills free to use? What license does it have?
okf-skills is open source under the MIT license. Check the license terms before using it in commercial products.
Is okf-skills still maintained?
Actively maintained. The last commit to okf-skills was on Nov 4, 2026.
What can I use okf-skills for?
Documenting a service's architecture and decisions as versioned markdown alongside the code. Giving coding agents structured project context they can read and cite. Validating knowledge bundles automatically in CI before merging. Reconstructing project documentation for a repository that has no existing bundle.
How do I install okf-skills?
Add the marketplace in Claude Code: /plugin marketplace add scaccogatto/okf-skills Install the okf plugin: /plugin install okf@scaccogatto Document a project in OKF by asking Claude to produce a bundle: /okf:okf produce .okf Validate the bundle before committing: /okf:validate .okf --strict
Where can I get okf-skills?
The source code and installation instructions are on GitHub: https://github.com/scaccogatto/okf-skills

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects