Skip to main content

okforge: a local-first LLM knowledge-base engine

Project description

okforge

A local-first LLM knowledge-base engine. Point it at your documents; it builds an interlinked wiki — per-document summaries, cross-document concept and entity pages, extracted images, and real page citations back to source. The wiki is plain Markdown with YAML frontmatter, readable in Obsidian or any editor, and queryable from a CLI, a chat REPL, or any MCP client.

Why

Most retrieval setups hand an LLM a pile of raw chunks and hope. okforge instead compiles your sources into curated pages ahead of time — concepts and entities that already synthesize what's spread across many documents, each claim traceable back to a (p. N) citation in the original source. That matters most for models with limited context, including small models running entirely on your own hardware: they don't have to reconstruct an answer from scratch every query, and what they do say is checkable against a specific page, not just plausible-sounding.

The output follows the Open Knowledge Format (OKF) — typed frontmatter, relative links, a predictable directory layout — so the wiki a KB produces is portable, not locked to okforge itself.

Install

pip install git+https://github.com/okforge/okforge@main

Quick start

mkdir my-kb && cd my-kb
okforge init          # scaffold raw/, wiki/, .okforge/  (--json for scripts)
okforge add paper.md  # ingest (pre-convert non-md/pdf inputs first)
okforge query "What does the paper conclude?"
okforge chat          # interactive REPL over the wiki
okforge list --json   # machine-readable state (also: status, okf-lint)
okforge describe "One line about this project."   # curated description

The query agent reads curated pages first, then drills for detail with a built-in grep_wiki lexical search (locate-then-read) rather than re-embedding everything. okf-lint checks a wiki bundle's OKF conformance.

Configuration lives in .okforge/config.yaml (model, language, entity types, …) and ~/.config/okforge/global.yaml (KB registry, default KB). The LLM endpoint is configured litellm-style — any OpenAI-compatible server works, including a local llama.cpp instance.

Ingesting scans and non-text documents

okforge add accepts Markdown, plain text, and PDF directly. Anything else — docx, pptx, scanned pages, photo catalogs — needs converting to Markdown first, by a tool that knows your material. For scanned pages specifically, okforge-vision-ocr (pip install okforge-vision-ocr) is built for exactly this: one vision-LLM call per page produces both a clean Markdown transcription and extracted photos/figures, plus a sibling <doc>.pages.json page array that okforge add reads directly for real (p. N) citations in the compiled summaries — no separate wiring needed.

okforge-vision-ocr scanned.pdf raw/book.md   # OCR + photo extraction
okforge add raw/book.md                      # ingest, with page citations

It works against any OpenAI-compatible vision-language model (tuned against a locally-hosted Qwen3.6-27B-MTP, but not tied to it).

MCP server

okforge mcp starts an MCP server (stdio transport) over the KB it's run against — same resolution as every other command (cwd walk-up, or --kb-dir). Tools: query, grep_wiki, read_wiki_page, status, and read_topic when the KB has topic_tree enabled. Read-only — ingest stays a deliberate CLI action.

claude mcp add --transport stdio okforge -- okforge --kb-dir /path/to/kb mcp

Works the same way with any MCP client that supports stdio transport.

No authentication. stdio is safe by default (it's just this process's own pipes, nothing listens on the network). If you bridge it to be reachable remotely, only do so over a network you already trust end-to-end (SSH tunnel, VPN) — never a directly-exposed port. Anyone who can reach it gets full read access to the KB, including query (which runs your configured LLM on your behalf), with no login step.

Topic tree (experimental, per-KB opt-in)

For knowledge bases that outgrow a flat concept list: set topic_tree: true in .okforge/config.yaml, then run okforge reindex. Existing concepts cluster into named concepts/<topic>/ directories, each with a _topic.md summary node; later ingests place new concepts by tree descent, and queries gain a read_topic navigation tool for browsing top-down instead of scanning a flat list.

Wiki layout

wiki/
  index.md              # document + concept index
  summaries/<doc>.md    # per-document summary (page citations when available)
  concepts/<name>.md    # cross-document concept pages
  entities/<name>.md    # named people/places/organizations/works
  sources/<doc>.md      # ingested source text
  sources/<doc>.json    # per-page text + images (when page-aware)
  sources/images/<doc>/ # extracted images
  log.md                # append-only ingest log

Development

uv run --extra dev python -m pytest tests/   # test suite
uv run --extra dev ruff check okforge tests  # lint
uv run --extra dev ruff format okforge tests # format

Origins

okforge began as a hard fork of VectifyAI/OpenKB, in the spirit of Karpathy's LLM-wiki idea, and has since diverged deliberately rather than tracking it — local-only by default, its own document-conversion boundary, and OKF conformance as a first-class goal rather than an incidental format.

License

Apache-2.0. Portions originate from the upstream OpenKB project (copyright the original authors); okforge-specific changes are maintained at okforge/okforge.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

okforge-0.9.1.tar.gz (782.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

okforge-0.9.1-py3-none-any.whl (221.2 kB view details)

Uploaded Python 3

File details

Details for the file okforge-0.9.1.tar.gz.

File metadata

  • Download URL: okforge-0.9.1.tar.gz
  • Upload date:
  • Size: 782.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for okforge-0.9.1.tar.gz
Algorithm Hash digest
SHA256 675a5e8838552ab777e9131764bdc67fa8d445fae7e82512adaa61333b2fb5d0
MD5 c5a801446d3f84af586f664a1043bb94
BLAKE2b-256 83abd84c1daaf914de2e6accf147d0aa3b8065eea659d43ef04ba6dfe07a8757

See more details on using hashes here.

Provenance

The following attestation bundles were made for okforge-0.9.1.tar.gz:

Publisher: publish.yml on okforge/okforge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file okforge-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: okforge-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 221.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for okforge-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 11c7c505db306ffa8d0f13e87ea4ccbb1e2f6b4a88d5b7068c6a0f7ed98ca071
MD5 5240d92d9694464baae2c099c5ed0d0f
BLAKE2b-256 7eaff5e3d1b3d039b6e2080f3cd6f5c77a2ce4945358940e43ee9cd4b294508d

See more details on using hashes here.

Provenance

The following attestation bundles were made for okforge-0.9.1-py3-none-any.whl:

Publisher: publish.yml on okforge/okforge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page