# okf

> okf is a Go CLI toolkit for the Open Knowledge Format (OKF): agentic-first, JSON-native, and vendor-neutral. It is a single-binary alternative to Google's Python, Gemini, and BigQuery reference implementation, designed to be discovered and driven by any AI agent through a machine-readable schema.

okf manages OKF bundles: directories of markdown concept files with YAML frontmatter, cross-linked into a knowledge graph. An agent loads the full CLI surface with one call (`okf schema`), drives commands that emit structured JSON on stdout (diagnostics go to stderr), recovers from typed error envelopes, and branches on exit codes that map one to one to error kinds (0 success, 1 validation, 2 io, 3 internal, 4 usage). JSON is the default, not an opt-in flag. okf is Go stdlib-only, Apache 2.0, and ships as a single binary with no runtime dependencies.

As of v0.2.0, okf implements OKF spec v0.2 end to end: provenance (sources with credibility signals and usage windows), trust (generated, verified, and derived trust tiers: unverified, machine-confirmed, human-reviewed), lifecycle (status and stale_after staleness), and Attested Computation contracts (runtime, parameters, computation, executor, attester). Legacy v0.1 fields (timestamp, # Citations) still parse, with migration warnings.

## Documentation

- [README](https://github.com/okfcli/okf/blob/main/README.md): full command reference, flags, install, and usage examples
- [Website](https://useokf.com): overview, the agentic-first design, and the command set
- [llms-full.txt](https://useokf.com/llms-full.txt): the complete site content as plain markdown for full ingestion

## Source and install

- [GitHub repository](https://github.com/okfcli/okf): source, issues, and releases (Apache 2.0)
- [Homebrew tap](https://github.com/okfcli/homebrew-okf): install with `brew install okfcli/okf/okf`
- Go install: `go install github.com/okfcli/okf/cmd/okf@latest`

## Commands

- [okf schema](https://github.com/okfcli/okf/blob/main/README.md): emit a JSON manifest of every command (name, args, stdout format, exit codes). This is how an agent discovers the CLI.
- [okf version](https://github.com/okfcli/okf/blob/main/README.md): version info as JSON
- [okf init](https://github.com/okfcli/okf/blob/main/README.md): scaffold a new OKF bundle (tables, datasets, playbooks)
- [okf index](https://github.com/okfcli/okf/blob/main/README.md): generate index.md files for progressive disclosure
- [okf validate](https://github.com/okfcli/okf/blob/main/README.md): validate a bundle against OKF v0.2 (frontmatter, links, trust, provenance, lifecycle, attested computations), exit 1 on errors
- [okf lint](https://github.com/okfcli/okf/blob/main/README.md): warnings-only validation, exit 0
- [okf list](https://github.com/okfcli/okf/blob/main/README.md): list every concept with status and trust tier as JSON
- [okf search](https://github.com/okfcli/okf/blob/main/README.md): filter concepts by tag, type, or text
- [okf show](https://github.com/okfcli/okf/blob/main/README.md): return a single concept's full content, trust and lifecycle state, sources, and computation contract as JSON
- [okf graph](https://github.com/okfcli/okf/blob/main/README.md): build the cross-link graph with node, edge, and density stats
- [okf backlinks](https://github.com/okfcli/okf/blob/main/README.md): reverse-link lookup for a concept

## Optional

- [About the Open Knowledge Format](https://github.com/okfcli/okf/blob/main/README.md): okf is an independent, community-built CLI for the Open Knowledge Format. It is not affiliated with, endorsed by, or sponsored by Google.