explaingit

lorsabyan/okf-skill

Analysis updated 2026-05-18

3PythonAudience · developerComplexity · 1/5LicenseSetup · easy

TLDR

An Agent Skill that teaches Claude Code and Codex to author, validate, and read Open Knowledge Format documentation bundles.

Mindmap

mindmap
  root((okf-skill))
    What it does
      Teaches agents OKF format
      Authors knowledge bundles
      Validates bundles
    Tech stack
      Python validator
      SKILL.md instructions
      YAML frontmatter
    Use cases
      Write OKF documentation
      Check bundle conformance
      Read knowledge bundles
    Audience
      Claude Code users
      Codex CLI users
      Documentation teams

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Teach Claude Code or Codex to author OKF knowledge bundles for datasets and APIs.

USE CASE 2

Validate whether an existing OKF bundle conforms to the v0.1 specification.

USE CASE 3

Give an AI agent a quick reference to the OKF format instead of writing custom prompts.

What is it built with?

PythonMarkdownYAML

How does it compare?

lorsabyan/okf-skill0marildo/imago0xdfi/glm-5.2-1m-4x-dgx-spark
Stars333
LanguagePythonPythonPython
Setup difficultyeasyeasyhard
Complexity1/52/55/5
Audiencedevelopergeneralresearcher

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Just copy the okf folder into the Claude Code or Codex skills directory.

You can use, modify, and distribute this project freely, including for commercial purposes, as long as you keep the copyright and license notices.

In plain English

okf-skill is an Agent Skill, a small package of instructions and tools that teaches coding assistants like Claude Code and OpenAI Codex how to work with a format called Open Knowledge Format, or OKF. OKF bundles are directories of markdown files with YAML frontmatter that describe things like datasets, tables, metrics, APIs, and playbooks. Instead of writing that documentation by hand, this skill gives an AI agent the knowledge it needs to author, validate, and read these bundles correctly. The repository is organized around a single skill folder. Inside it, a file called SKILL.md holds a quick reference to the OKF format along with workflows for authoring, validating, and consuming bundles. A references folder contains the full OKF v0.1 specification, copied from Google's knowledge-catalog project. A scripts folder holds a validator written in plain Python with no external dependencies, which checks whether a given bundle follows the format correctly. Installing the skill is a matter of copying or symlinking the okf folder into the right place. For Claude Code, that means placing it in a personal skills directory that applies across all projects, or in a project-specific skills folder. Once it is there, Claude Code recognizes tasks related to OKF or knowledge bundles automatically, or a user can call it directly with a slash command. Codex CLI uses the same file format, so the folder can be copied into its skills directory in the same way. The included validator script can be run from the command line against any bundle directory. It checks required structural rules, such as parseable frontmatter and non-empty type fields, as hard errors, and flags softer issues like broken cross-links or missing descriptions as warnings. A strict mode turns those warnings into errors as well. The author reports that the validator passes cleanly against the three reference bundles shipped with the original OKF specification project. The repository also points to a companion project called okf-reader, a separate web app for browsing OKF bundles. The skill itself is released under the Apache 2.0 license, though the reproduced specification document keeps its original Google copyright.

Copy-paste prompts

Prompt 1
Install the okf-skill into my Claude Code skills folder and show me how to author a new OKF bundle.
Prompt 2
Use okf-skill to validate my knowledge-catalog bundle and explain any errors or warnings.
Prompt 3
Help me set up okf-skill for Codex CLI so it can read OKF bundles in this project.
Prompt 4
Explain the OKF v0.1 spec referenced in okf-skill so I can structure my documentation correctly.

Frequently asked questions

What is okf-skill?

An Agent Skill that teaches Claude Code and Codex to author, validate, and read Open Knowledge Format documentation bundles.

What language is okf-skill written in?

Mainly Python. The stack also includes Python, Markdown, YAML.

What license does okf-skill use?

You can use, modify, and distribute this project freely, including for commercial purposes, as long as you keep the copyright and license notices.

How hard is okf-skill to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is okf-skill for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.