validate

Featured

Check that an Open Knowledge Format (OKF) bundle is conformant with the v0.2 spec (§11). Use when asked to validate, lint, or check an OKF bundle, or before committing changes to one. Runs a deterministic Python checker — not an eyeball pass. Also migrates a v0.1 bundle to v0.2 in place with `--migrate`.

AI & Automation 382 stars 35 forks Updated 6 days ago MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
86
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Validate an OKF bundle Run the deterministic conformance checker against the target bundle. Default to the project's `.okf/` directory when no path is given. ```bash uv run "${CLAUDE_SKILL_DIR}/scripts/okf_validate.py" $ARGUMENTS ``` If `uv` is unavailable, fall back to: ```bash python3 -m pip install --quiet pyyaml && \ python3 "${CLAUDE_SKILL_DIR}/scripts/okf_validate.py" $ARGUMENTS ``` `${CLAUDE_SKILL_DIR}` resolves whether this skill runs as part of the `okf` plugin or is installed standalone (e.g. via `npx skills add`), so the checker is always found alongside the skill. Interpret the result: - **ERROR** → a hard §11 conformance failure (no parseable frontmatter, or a missing/empty `type`). The bundle is non-conformant. Fix every one. - **warn** → soft guidance (missing recommended field, non-ISO log date, broken cross-link, a malformed v0.2 family, a footnote naming no source, an actor that misses the §7 shapes, a computation path that resolves nowhere). Never blocks; broken links in particular are explicitly tolerated by the spec (§6.1). Fix when cheap. One warning is worth more than the others: a §7 near-miss such as `Human:dana` or `human/dana`. §5.3 keys trust tiers off the exact lowercase `human:` prefix, so the concept silently reads as machine-confirmed when a person did review it. Fix that one on sight. v0.1 bundles validate too: a legacy `timestamp` or `# Citations` section is reported as a warning naming its v0.2 replacement (`generated.at...

Details

Author
scaccogatto
Repository
scaccogatto/okf-skills
Created
2 months ago
Last Updated
6 days ago
Language
Python
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

okf-lint

Validate an Open Knowledge Format (OKF) knowledge base (a wiki/ bundle of Markdown + YAML frontmatter) for spec conformance and house rules. Use when the user wants to check, validate, or lint their wiki / knowledge base, or after editing KB pages. Triggers: "lint my wiki", "validate the knowledge base", "check the OKF bundle", "is my wiki conformant", "run the okf linter". Reports errors (must fix) and warnings (review), with a non-zero exit on failure.

1 Updated 1 months ago
thattimc
AI & Automation Featured

okf

Author, maintain, and consume Open Knowledge Format (OKF) knowledge bundles — portable markdown + YAML frontmatter that both humans and agents read. Use when capturing project knowledge (services, APIs, schemas, metrics, runbooks, decisions) into an OKF bundle, when updating one after code or docs change, or when a repository contains an `.okf/` (or other OKF) bundle that should inform the task. Triggers on: "document this in OKF", "update the knowledge bundle", "capture this as a concept", or any work in a repo that has an OKF bundle.

382 Updated 6 days ago
scaccogatto
Data & Documents Featured

okf-open-knowledge-format

Create, validate, and enrich Open Knowledge Format (OKF) bundles — the open spec for representing organizational knowledge as markdown files with YAML frontmatter. Use when the user mentions 'OKF', 'Open Knowledge Format', 'knowledge bundle', 'OKF bundle', 'create a knowledge base for agents', 'validate OKF', 'convert to OKF', 'enrich knowledge docs', 'agent-readable knowledge', 'LLM wiki', 'knowledge catalog', 'kcmd', or wants to structure knowledge as markdown files for AI agent consumption. Also use when the user has a directory of markdown files and wants to make them interoperable or conformant with the OKF standard. Even for simple requests like 'make this folder OKF conformant' — the skill has critical structural rules the agent needs.

77 Updated today
fabricioctelles