/okf maintains a project knowledge wiki in Open Knowledge Format (OKF): Markdown concepts with YAML frontmatter, deterministic validation, and optional shareable embedding shards.
- git
- gh
- Python 3
- PyYAML
Embedding commands also need Ollama or an API key for the selected provider.
Overdeck users receive this skill through pan sync.
Standalone Claude Code users install it from the mirror repo, eltmon/okf — symlink so git pull updates it in place:
git clone https://github.com/eltmon/okf.git ~/Projects/okf
mkdir -p ~/.claude/skills
ln -s ~/Projects/okf ~/.claude/skills/okfOr copy-install instead of symlinking:
cp -R ~/Projects/okf ~/.claude/skills/okfThe skill remains portable. Its core scripts do not import Overdeck and require only git, gh, Python 3, and PyYAML for non-embedding workflows.
-
Create or connect a bundle:
/okf init
-
Document the area you are about to change:
/okf study "overtime calculations" -
Pull focused prompt context before implementation:
/okf extract "overtime calculations" --budget 1200 -
After implementation, capture what the session learned:
/okf retro
-
Validate before opening or merging the knowledge PR:
/okf validate --strict
| Command | Summary |
|---|---|
/okf init |
Create or connect the knowledge bundle and pointer file. |
/okf open [--no-install] [--no-browser] |
Open the configured bundle in the local visual knowledge viewer. |
/okf author "<topic>" |
Write or update one concept for one idea. |
/okf convert <path> |
Convert existing docs into OKF without destructive edits. |
/okf sync [--topic "<focus>"] |
Update concepts from code or documentation diffs. |
/okf study "<focus>" |
Pre-feature pass that documents current behavior. |
/okf retro |
Post-implementation pass that captures rediscovered knowledge. |
/okf extract "<query>" [--budget <tokens>] |
Return ranked, token-budgeted, cited concepts for prompts. |
/okf validate [--strict] |
Run the deterministic conformance gate. |
/okf lint |
Run advisory semantic patrol. |
/okf embed [--profile <name>] |
Update embedding shards and rebuild the local index. |
Run /okf study "<focus>" before planning or implementation. The pass researches the current codebase, writes what exists today, and cites evidence. This turns rediscovery into durable concepts before the work starts.
Run /okf sync [--topic "<focus>"] when code or docs change. The pass maps diffs to concepts, updates affected pages, appends log.md, regenerates indexes, and validates.
Run /okf retro after implementation. The pass asks what knowledge would have made the work easier, then files those answers as concepts through the knowledge PR flow.
When using a bundle for answers or prompt context:
- read
index.mdfirst. - load only relevant concepts.
- answer only from loaded concepts.
- cite concept IDs.
- never invent missing knowledge.