okf-cli — Open Knowledge Format tooling
Convert plain markdown directories into OKF-conformant knowledge bundles. okf bundle generates YAML frontmatter, concept types, provenance, and per-directory index.md files; okf validate, okf list, and okf read consume the resulting bundle.
Install
uv tool install okf-cli
Dev quickstart
uv sync
uv run okf --help
uv run okf --version
Commands
| Command | Purpose |
|---|---|
okf bundle <input-dir> [output-dir] |
Convert markdown into an OKF bundle |
okf validate <directory> |
Check OKF v0.2 §11 conformance |
okf list <directory> |
List concepts (ID, type, title, description) |
okf read <directory> <concept-id> |
Print a concept by ID |
okf serve-mcp <directory> |
Serve a conformant bundle over MCP HTTP |
Run okf <command> --help for options such as --default-type, --force, --strict, and --dry-run.
MCP server
Install the optional MCP dependency, then serve a conformant bundle over Streamable HTTP:
uv sync --extra mcp
uv run okf serve-mcp example_knowledge_base
The server binds to 127.0.0.1:8000 by default and listens at http://127.0.0.1:8000/mcp. Use --host and --port to change the bind address. The server exposes read-only list_concepts and read_concept tools. Non-local binds have no built-in authentication; use them only on a trusted network or behind an authenticated proxy.
Quick example
uv run okf bundle example --default-type reference --force
uv run okf validate example_knowledge_base
uv run okf list example_knowledge_base
uv run okf read example_knowledge_base tables/customers
Documentation
- Detailed user and contributor docs: wiki/quickstart.md
- Agent contributor context: AGENTS.md
- OKF v0.2 specification: SPEC/OKF_SPEC_V0_2.md
1 maintainer
Metadata
1 maintainer
Release files for okf-cli 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| okf_cli-0.8.0.tar.gz | 143.0 kB | Without provenance | Details for okf_cli-0.8.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| okf_cli-0.8.0-py3-none-any.whl | Python 3 | none | any | Details for okf_cli-0.8.0-py3-none-any.whl |
Total release size: 161.2 kB
Release files / okf_cli-0.8.0.tar.gz
| Download URL | okf_cli-0.8.0.tar.gz |
|---|---|
| Size | 143.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1d324d857e9ee32272294cacb2da3f9e3628d56e201367b74456ece3fe19a509
|
|
BLAKE2b-256 checksum How to use checksums |
9687aea5a892aab73898c69c6ea8e0e7c77ece4e61a63593decc98dd55d2257e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / okf_cli-0.8.0-py3-none-any.whl
| Download URL | okf_cli-0.8.0-py3-none-any.whl |
|---|---|
| Size | 18.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1564c560c17c35dd1d20c3781a867800ebaf81208588fc0d89eb5b978cd95982
|
|
BLAKE2b-256 checksum How to use checksums |
475e100f9c290a8948fb53b7d0ee2d063851786e15374c20ed22ce2756de978e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for okf-cli 0.8.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
