okforest

The OKForest CLI: validate, inventory, and scaffold Open Knowledge Format (OKF) v0.2 trees.

npx okforest validate .                 # exit 1 on errors; warnings never fail
npx okforest validate . --format json   # for CI and tools
npx okforest inventory .                # types, tags, keys, near-duplicates
npx okforest init sales-okf --template company --name "Sales knowledge"

To also check D2 and Mermaid diagram syntax, install the optional packages alongside it:

npx -p okforest -p @d2lang/d2 -p mermaid okforest validate .

In GitHub Actions, use OKForest Validate (uses: okforest/validate-action@v1): the same rules, with annotations on the pull request and the diagram checks included.

Rules, options, and what counts as a concept: see the OKForest CLI README.

Apache-2.0 · © Preneur LLC · okforest.ai