okfsmith documentation

okfsmith is a Python CLI that converts messy documents (PDFs, markdown, wiki dumps, Notion exports) into OKF v0.2 knowledge bundles: markdown files with YAML frontmatter, plus reserved index.md / log.md files — validated, visualized, and servable over MCP.

Guides

• Install — requirements, extras, shell completion
• Quickstart — your first bundle in five minutes
• Commands — full CLI reference with examples
• Ingesting & parsing — what ingest does stage by stage: PDF / Office / Notion inputs and parser tiers
• LLM providers — Ollama, API keys, model configuration
• Validation & error codes — conformance rules, exit codes
• MCP server — serve a bundle to agents (Claude, Cursor, Copilot, Gemini)
• Skill pack — the okfsmith-build agent skill
• Troubleshooting — common failures and fixes
• FAQ — short answers
• Architecture overview — the eight-stage pipeline map

Facts that matter

• Spec: OKF v0.2 (GoogleCloudPlatform/open-knowledge-format), §11 conformance rules enforced by validate.
• License: Apache-2.0.
• Python: 3.10+.
• Offline-first: parsing, sectioning, validation, and the graph viewer work with no network. Only LLM extraction needs a model endpoint.
• No lock-in: a bundle is plain markdown + YAML. Any tool that reads markdown can read it.

For agents (llms.txt)

A compact machine-readable map of these docs: llms.txt.