Skip to content

okfctl

Author and maintain Open Knowledge Format bundles from the command line. A conformant consumer of the OKF spec — pure Go, no CGO, no model runtime.

Install the latest tagged release with go install:

go install github.com/cwest/okfctl@v0.2.0

Latest release: v0.2.0.

Or download a prebuilt binary for your platform from the releases page (darwin and linux, amd64 and arm64). Each archive bundles both okfctl and the okfctl-search plugin.

okfctl scaffolds a bundle, adds and moves nodes without breaking links, keeps the reserved index.md/log.md files current, checks a corpus against the spec, and reports on its health and link graph.

The Open Knowledge Format is a specification owned by Google (GoogleCloudPlatform/knowledge-catalog). okfctl does not author that spec — it is a consumer that conforms to it. Where the spec defines behavior, the spec wins. The tool enforces the spec floor for everyone and keeps anything stricter behind an explicit opt-in overlay, so an unknown type or a future frontmatter key never fails validate.

Concepts

Bundles, nodes, the link graph, and the reserved files — read this first. Concepts

Author a bundle

From an empty directory to a validated bundle. Authoring guide