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, any MCP client, or the companion okforge-webui web app.

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. Hosted providers work through the same model string: e.g. okforge init --model openrouter/qwen/qwen3.6-27b with LLM_API_KEY=sk-or-... in the KB's .env runs the whole pipeline against OpenRouter, no other changes.

One tip for thinking-capable models (the Qwen3 family in particular): left alone they spend a hidden reasoning pass on every pipeline call, and each serving stack spells "don't reason" differently. Put the dialect your endpoint understands in the KB's config.yaml — for llama.cpp/vLLM:

llm_extra_body:
  chat_template_kwargs:
    enable_thinking: false

and for OpenRouter:

llm_extra_body:
  reasoning:
    enabled: false

The wrong (ignored) dialect fails silently — the wiki still builds, you just pay reasoning-token cost and latency on every call. Measured on qwen3.6-27b via OpenRouter: a trivial completion drops from 199 tokens to 2 with the block in place.

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.

A PDF at/above pageindex_threshold pages (default 20) is rejected the same way — okforge doesn't auto-chunk long documents, so pre-chunk it into smaller page ranges first, the same as any other large source.

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 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.

Two transports, picked with --transport:

# stdio (default) — the client spawns this process itself
claude mcp add --transport stdio okforge -- okforge --kb-dir /path/to/kb mcp

# Streamable HTTP — this process listens on a socket for clients to connect to
okforge --kb-dir /path/to/kb mcp --transport http --port 8000
claude mcp add --transport http okforge http://127.0.0.1:8000/mcp

Works the same way with any MCP client that supports stdio or Streamable HTTP.

No authentication, on either transport. stdio is safe by default (it's just this process's own pipes, nothing listens on the network). --transport http binds 127.0.0.1 by default for the same reason — if you change --host or put it behind a reverse proxy, only do so over a network you already trust end-to-end (SSH tunnel, VPN, an authenticating proxy) — 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.

Testing the http transport directly (e.g. with curl, without a real MCP client) means implementing the Streamable HTTP session handshake yourself — a real client (claude mcp add --transport http ...) does all of this for you automatically:

  • Accept must include both application/json and text/event-stream — either alone gets 406 Not Acceptable.
  • Call initialize first and capture the Mcp-Session-Id response header; send it back as a header on every subsequent request. There's no session without it.
  • Responses are SSE (event: message / data: {...}) — strip the data: prefix and parse the rest as JSON.
  • query's argument key is question, not query.

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

Roadmap

A web UI already exists as a separate companion app: okforge-webui drives the whole scan-to-wiki pipeline from a browser — PDF inbox, OCR pilots, chunked ingest jobs with live progress, wiki browsing and query, and static-site publishing — over the same one-directory-per-KB layout this README describes (it discovers KBs by scanning a kbs/ root, so CLI-created KBs placed there just appear).

Planned, not yet built:

  • Multiple LLM endpoints — a KB config today points model: at one litellm-style endpoint; planned support for registering several (different hosts, different models) and choosing between them per call rather than being locked to one for the whole KB.
  • Parallel processing — ingest and query are fully serial today (one add at a time, one generation call at a time); planned concurrency for page-level work and multi-document ingest, bounded by each endpoint's slot budget so throughput scales with the hardware actually available.

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.5.tar.gz (777.5 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.5-py3-none-any.whl (219.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: okforge-0.9.5.tar.gz
  • Upload date:
  • Size: 777.5 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.5.tar.gz
Algorithm Hash digest
SHA256 17921af58c6a59bff0c9ee312a106f596708a6ea3142c6332888985891094dda
MD5 381638a95b2763214817804ca4bcb78b
BLAKE2b-256 d0d2ba13eced0dc1fce679286632a8edcadf6a5556ffc9d55c5f345535a9d239

See more details on using hashes here.

Provenance

The following attestation bundles were made for okforge-0.9.5.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.5-py3-none-any.whl.

File metadata

  • Download URL: okforge-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 219.7 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 07c2173eb4217a633bbe79e95871e5d3080f3da0e5e232f53672524cc6b1999b
MD5 a48f7ac9bbfda02efd806549873a07fe
BLAKE2b-256 e21cfd0347d6f07c13abbf8e06aa6b57eebc9ce4056d976ea5c075f4537fe808

See more details on using hashes here.

Provenance

The following attestation bundles were made for okforge-0.9.5-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