Skip to main content

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

Metadata

Release files for okf-cli 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for okf-cli 0.7.0
File Size Uploaded Provenance Actions
okf_cli-0.7.0.tar.gz 60.6 kB Without provenance Details for okf_cli-0.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for okf-cli 0.7.0
File Interpreter ABI Platform Actions
okf_cli-0.7.0-py3-none-any.whl Python 3 none any Details for okf_cli-0.7.0-py3-none-any.whl

Total release size: 76.8 kB

Release files / okf_cli-0.7.0.tar.gz

Download URL okf_cli-0.7.0.tar.gz
Size 60.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8585cc90a75d70d94b9b7619ed4666dcce8b2c2b0089f6b9e5118214377bffeb
BLAKE2b-256 checksum
How to use checksums
802510468a636aba74ffe4fa5cee7387e1ad5131822c57a1fa52fb96bb94c12e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","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.7.0-py3-none-any.whl

Download URL okf_cli-0.7.0-py3-none-any.whl
Size 16.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fee56c4042ed0d414185e48cf8745196bec39519ba7e180712b8ed6f293f4fb1
BLAKE2b-256 checksum
How to use checksums
d5486607bcf7665e36e867fbbe683313ee033e4967870a56d5ee41b0576121e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","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.7.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page