OKF Converter

Developer CLI

OKF CLI: convert and validate Open Knowledge Format.

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.

Try web converterValidate OKF

OKF developer workflow

Generate locally, validate in CI, then inspect the bundle.

Use the OKF generator for a first bundle, run the CLI validator before merging, and open the browser workbench when you need a human-readable OKF viewer.

GenerateOKF generator

Create typed Markdown files, indexes, and readiness reports.

ValidateOKF validator

Check metadata, links, bundle structure, and readiness.

ViewOKF viewer and converter

Inspect generated output and download clean Markdown in the browser.

Commands

Local workflows for docs teams and CI.

CLI

Convert a folder

Run this from the repository root after installing dependencies.

node scripts/okf-converter.mjs convert ./docs --out ./okf

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