CLI
Convert a folder
Run this from the repository root after installing dependencies.
node scripts/okf-converter.mjs convert ./docs --out ./okf
Developer CLI
Convert and validate OKF from the command line.
The CLI uses the same OKF core as the web workbench, so Markdown conversion, bundle indexes, validation scores, and report output stay consistent across local, CI, and browser workflows.
Commands
Local workflows for docs teams and CI.
CLI
Convert one file
Run this from the repository root after installing dependencies.
node scripts/okf-converter.mjs convert ./README.md --out ./okf
CLI
Validate for CI
Run this from the repository root after installing dependencies.
node scripts/okf-converter.mjs validate ./okf --json
CLI
Export to a GitHub repo branch
Run this from the repository root after installing dependencies.
node scripts/okf-converter.mjs github-export ./okf --repo ../docs-repo --target okf --branch okf-export
CLI
Open a pull request with GitHub CLI
Run this from the repository root after installing dependencies.
node scripts/okf-converter.mjs github-export ./okf --repo ../docs-repo --target okf --branch okf-export --open-pr