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 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.
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
Planned, not yet built:
- Web UI — a native UI for browsing and querying a KB (search,
read wiki pages, run
query/chat) shipped with the engine itself. - 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
addat 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file okforge-0.9.2.tar.gz.
File metadata
- Download URL: okforge-0.9.2.tar.gz
- Upload date:
- Size: 784.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f63661300148bc69104588c4c9ffc2521ddf754a52807683205da9cf6257167d
|
|
| MD5 |
2fe4dd9f064d2ce42654b19ac43a3fb7
|
|
| BLAKE2b-256 |
a07432259db9ce83c643f9a574e33a20b2d48364b2f7eebd3bbdb0d787b3505c
|
Provenance
The following attestation bundles were made for okforge-0.9.2.tar.gz:
Publisher:
publish.yml on okforge/okforge
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
okforge-0.9.2.tar.gz -
Subject digest:
f63661300148bc69104588c4c9ffc2521ddf754a52807683205da9cf6257167d - Sigstore transparency entry: 2126882885
- Sigstore integration time:
-
Permalink:
okforge/okforge@e141fa3611e93fbe5fd3cf70a6ef118963560635 -
Branch / Tag:
refs/tags/v0.9.2 - Owner: https://github.com/okforge
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e141fa3611e93fbe5fd3cf70a6ef118963560635 -
Trigger Event:
push
-
Statement type:
File details
Details for the file okforge-0.9.2-py3-none-any.whl.
File metadata
- Download URL: okforge-0.9.2-py3-none-any.whl
- Upload date:
- Size: 222.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f8eb693e1127a91959b93fa5655560ed33184d40de2631457328819c10e252fc
|
|
| MD5 |
9c6f8630d5df64be91667c41048dcb34
|
|
| BLAKE2b-256 |
b218b4d7644bfd1b261dc2a4efe0c0d4d3d8e256efec7c1d670b1f8fdfbb29a3
|
Provenance
The following attestation bundles were made for okforge-0.9.2-py3-none-any.whl:
Publisher:
publish.yml on okforge/okforge
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
okforge-0.9.2-py3-none-any.whl -
Subject digest:
f8eb693e1127a91959b93fa5655560ed33184d40de2631457328819c10e252fc - Sigstore transparency entry: 2126882941
- Sigstore integration time:
-
Permalink:
okforge/okforge@e141fa3611e93fbe5fd3cf70a6ef118963560635 -
Branch / Tag:
refs/tags/v0.9.2 - Owner: https://github.com/okforge
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e141fa3611e93fbe5fd3cf70a6ef118963560635 -
Trigger Event:
push
-
Statement type: