Skip to content

OKF Skill — Install & Use

An agent skill that teaches coding agents (Claude, Codex, Cursor, Kiro, Windsurf) to create, validate, and enrich OKF bundles.

Install

Claude Code / Kiro CLI

# Add to your project
npx skills add fabricioctelles/skills/okf-open-knowledge-format

Or manually — clone and reference:

git clone https://github.com/fabricioctelles/skills.git ~/.skills

Then add to your .claude/settings.json or AGENTS.md:

{
  "skills": ["~/.skills/skills/okf-open-knowledge-format/SKILL.md"]
}

Cursor / Windsurf

Add to your project’s rules or instructions file:

Read and follow: https://raw.githubusercontent.com/fabricioctelles/skills/main/skills/okf-open-knowledge-format/SKILL.md

Direct reference (any agent)

Point your agent at the raw URL:

https://raw.githubusercontent.com/fabricioctelles/skills/main/skills/okf-open-knowledge-format/SKILL.md

What the Skill Does

CapabilityDescription
CreateGenerate conformant OKF bundles from scratch
ValidateCheck the 3 conformance rules, report errors and warnings
EnrichAdd schema, citations, cross-links, fill recommended fields
GenerateAuto-create index.md and log.md files
ConvertTransform Notion exports, Obsidian vaults, or CSVs into OKF

Usage Examples

Create a bundle

"Create an OKF bundle documenting our API endpoints: /users, /orders, /payments"

The agent will generate a full directory with concept docs, cross-links, and index.

Validate existing docs

"Validate this folder against OKF spec"

The agent checks all 3 conformance rules and reports pass/fail with file-level detail.

Convert from Obsidian

"Convert my Obsidian vault at ./knowledge/ to OKF format"

The agent converts wikilinks to standard links, ensures type fields exist, and generates index/log files.


Included Resources

The skill bundles reference material the agent loads on demand:

FileContent
references/spec-v01.mdFull OKF v0.1 spec (451 lines)
references/examples.md3 complete example bundles
references/conversion.mdConversion guides (Notion, Obsidian, CSV)
scripts/validate.shBash validator script (zero dependencies)

The validate.sh Script

You can also run the bundled validator directly:

chmod +x scripts/validate.sh
./scripts/validate.sh ./my-bundle/

Output:

✅ Bundle is OKF v0.1 conformant
⚠️  2 warning(s)