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 |
Run okf <command> --help for options such as --default-type, --force, --strict, and --dry-run.
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
Release files for okf-cli 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| okf_cli-0.6.1.tar.gz | 59.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| okf_cli-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 75.8 kB
Release files / okf_cli-0.6.1.tar.gz
| Download URL | okf_cli-0.6.1.tar.gz |
|---|---|
| Size | 59.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec800417eee88f4114eabd4ee633c88cfc909e34a39a6f11cbfba5e9ad786ee6
|
|
BLAKE2b-256 checksum How to use checksums |
993cdf637bb4d62c89bef69bc321a2963879df978ec0168e021d6634754e661e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.6.1-py3-none-any.whl
| Download URL | okf_cli-0.6.1-py3-none-any.whl |
|---|---|
| Size | 15.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e8f4d2fe484ae4f98d294b014e83dc15822e673163215b8cf473acc7c78f28a8
|
|
BLAKE2b-256 checksum How to use checksums |
0d99826ba03c6cc1652dfec1c6b3eb9603e3c422e58954b013b85ed20d927080
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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}
|
