okforge 0.6.2__tar.gz

okforge-0.6.2/.claude-plugin/marketplace.json

@@ -0,0 +1,29 @@
+{
+  "name": "vectify",
+  "owner": {
+    "name": "designcomputer"
+  },
+  "metadata": {
+    "description": "Skills for navigating an okforge-compiled knowledge base from agent CLIs (Claude Code, Codex, Gemini CLI).",
+    "version": "0.6.1"
+  },
+  "plugins": [
+    {
+      "name": "openkb",
+      "description": "Navigate an okforge-compiled wiki: discover documents and concepts via openkb CLI commands, read concept and summary pages directly, and follow wikilinks across the knowledge graph. Adapted from the original OpenKB skill by Ray (Vectify AI).",
+      "source": "./",
+      "strict": false,
+      "version": "0.6.1",
+      "author": {
+        "name": "designcomputer"
+      },
+      "homepage": "https://github.com/designcomputer/okforge",
+      "repository": "https://github.com/designcomputer/okforge",
+      "license": "Apache-2.0",
+      "keywords": ["knowledge-base", "wiki", "okforge", "okf", "openkb", "rag", "agent-skill"],
+      "skills": [
+        "./skills/openkb"
+      ]
+    }
+  ]
+}

okforge-0.6.2/.env.example

@@ -0,0 +1,6 @@
+# LLM API key (required) — works with any LiteLLM-supported provider
+# OpenAI:    LLM_API_KEY=sk-...
+# Anthropic: LLM_API_KEY=sk-ant-...
+# Gemini:    LLM_API_KEY=AIza...
+# DeepSeek:  LLM_API_KEY=sk-...
+LLM_API_KEY=your-key-here

okforge-0.6.2/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+# Least-privilege token: this workflow only reads the repo. Arbitrary
+# dependency build code runs during install, so never expose a writable
+# token to it (see the supply-chain notes in pyproject.toml).
+permissions:
+  contents: read
+
+# Cancel superseded runs on the same ref (rapid PR pushes) instead of
+# letting them pile up and post stale statuses.
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39  # v8.2.0
+        with:
+          version: "0.10.2"
+          enable-cache: true
+
+      # `uv sync --locked` installs the exact uv.lock resolution (direct AND
+      # transitive deps) and fails if the lock is stale — a bare `pip install`
+      # would ignore the lockfile and let transitive versions float, defeating
+      # the repo's exact-pin supply-chain policy. Run `uv lock` and commit the
+      # lockfile whenever pyproject dependencies change.
+      - name: Install (locked)
+        run: uv sync --locked --extra dev --python 3.12
+
+      # --no-sync: don't let `uv run` re-sync without the dev extra and
+      # uninstall the tools it is about to run.
+      - name: Ruff lint
+        run: uv run --no-sync ruff check .
+
+      - name: Ruff format check
+        run: uv run --no-sync ruff format --check .
+
+      - name: Mypy
+        run: uv run --no-sync mypy openkb
+
+      - name: Pytest
+        run: uv run --no-sync pytest

okforge-0.6.2/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+name: Publish to PyPI
+
+# Release flow:
+#   1. `git tag -a vX.Y.Z -m "Release X.Y.Z" && git push origin vX.Y.Z`
+#   2. This workflow builds the package (hatch-vcs derives the version from
+#      the tag automatically — pyproject.toml has no static version field),
+#      publishes to PyPI via OIDC trusted publishing, and creates a GitHub
+#      Release with auto-generated notes.
+#
+# Tag must follow PEP 440: `v0.1.4`, `v0.2.0rc1`, `v0.1.4.dev0`. The
+# leading `v` is stripped by hatch-vcs when computing the package version.
+#
+# Do not run `python -m build && twine upload` locally — that bypasses the
+# GitHub Release creation and produces a release without an attached
+# changelog. PyPI rejects duplicate version uploads, so if the workflow
+# fails after PyPI publish succeeded, manually create the missing GitHub
+# Release with `gh release create vX.Y.Z`.
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # OIDC trusted publishing to PyPI
+      contents: write   # Create GitHub Release
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+        with:
+          fetch-depth: 0   # hatch-vcs needs full history + tags
+
+      - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # release/v1.14.0
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda  # v3.0.0
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          generate_release_notes: true
+          files: dist/*

okforge-0.6.2/.gitignore

@@ -0,0 +1,26 @@
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.venv/
+venv/
+*.db
+.DS_Store
+.env
+
+# Knowledge base test artifacts
+raw/
+wiki/
+.openkb/
+output/
+
+# Local only
+docs/internal/
+.claude/
+
+# Heavy test-input documents for the examples (the old blanket `docs/` rule
+# used to catch this dir at any depth; the anchored `docs/internal/` above
+# does not). The PDFs already tracked on main stay tracked — this only stops
+# new drops from being swept into commits.
+examples/docs/

okforge-0.6.2/AGENTS.md

@@ -0,0 +1,44 @@
+# AGENTS.md — okforge map for coding agents
+
+okforge (a hard fork of VectifyAI/OpenKB) compiles raw documents into an interlinked wiki knowledge base using
+LLMs (vectorless retrieval via PageIndex). This repo is developed **agent-first**:
+humans steer, agents execute. Optimize changes for agent legibility.
+
+## Read next
+- `docs/golden-principles.md` — mechanical rules to follow (enforced where possible).
+- `docs/internal/superpowers/{specs,plans}/` — design history & plans *(maintainer-local, not in git)*.
+- `README.md` — user-facing overview and commands.
+
+## Dev commands
+- Install: `pip install -e ".[dev]"`  (or `uv sync --extra dev` — plain `uv sync` skips the dev tools)
+- Run CLI: `okforge <command>`  (entry point: `openkb.cli:cli`; `openkb` kept as a transition alias)
+- Test: `pytest`
+- Lint/format/types: `ruff check .` · `ruff format .` · `mypy openkb`
+
+## Module map (openkb/)
+- `cli.py` — Click CLI entry point & command wiring *(large; see tech-debt)*.
+- `config.py` — config loading/validation (LiteLLM passthrough, env).
+- `converter.py` — document → markdown conversion (markitdown).
+- `url_ingest.py` — fetch & ingest URLs (trafilatura).
+- `images.py` — figure/image extraction & handling.
+- `indexer.py` — PageIndex tree indexing for long docs.
+- `mutation.py` — crash-safe, serial KB mutations.
+- `locks.py` — atomic writes / file locking (`atomic_write_text`, portalocker).
+- `state.py` — run/session state tracking.
+- `frontmatter.py` — YAML frontmatter round-trip (OKF).
+- `schema.py` — page/content schema constants & helpers.
+- `lint.py` — structural wiki lint (broken links, orphans, index sync).
+- `tree_renderer.py`, `visualize.py`, `watcher.py` — rendering / graph / file watch.
+- `agent/compiler.py` — LLM wiki compiler *(large; see tech-debt)*.
+- `agent/linter.py` — semantic (LLM) wiki lint (contradictions, gaps, staleness).
+- `agent/chat.py`, `agent/chat_session.py` — chat over the wiki *(chat.py large)*.
+- `agent/query.py` — one-off query generator.
+- `agent/tools.py` — shared wiki read/write tool functions used by query/linter (and by chat indirectly via `query.build_chat_agent`).
+- `agent/skills.py`, `agent/skill_runner.py`, `skill/` — Skill Factory.
+- `deck/`, `templates/`, `prompts/` — deck output, templates, prompt assets.
+
+## Hard invariants
+- Deps are pinned **exactly** (supply-chain caution). Vet before bumping.
+- Wiki writes go through `locks.py` / `mutation.py` (never ad-hoc).
+- Modules stay < 800 lines (`tests/test_file_size.py`); grandfathered files are in tech-debt.
+- Keep this file a short map — put depth in `docs/`.

okforge-0.6.2/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

okforge-0.6.2/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Vectify AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

okforge-0.6.2/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: okforge
+Version: 0.6.2
+Summary: okforge: a local-first LLM knowledge-base engine
+Project-URL: Repository, https://github.com/okforge/okforge
+Project-URL: Homepage, https://github.com/okforge/okforge
+Project-URL: Issues, https://github.com/okforge/okforge/issues
+Author: designcomputer
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,document,knowledge-base,llm,pageindex,rag,retrieval
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: click==8.4.0
+Requires-Dist: json-repair==0.59.10
+Requires-Dist: litellm==1.87.2
+Requires-Dist: openai-agents==0.17.3
+Requires-Dist: pageindex==0.3.0.dev1
+Requires-Dist: portalocker==3.2.0
+Requires-Dist: prompt-toolkit==3.0.52
+Requires-Dist: python-dotenv==1.2.2
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: rich==15.0.0
+Requires-Dist: trafilatura==2.0.0
+Requires-Dist: watchdog==6.0.0
+Provides-Extra: dev
+Requires-Dist: mypy==1.15.0; extra == 'dev'
+Requires-Dist: pytest-asyncio==1.3.0; extra == 'dev'
+Requires-Dist: pytest==9.0.3; extra == 'dev'
+Requires-Dist: ruff==0.9.7; extra == 'dev'
+Requires-Dist: types-pyyaml==6.0.12.20260518; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# 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)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) —
+typed frontmatter, relative links, a predictable directory layout — so
+the wiki a KB produces is portable, not locked to okforge itself.
+
+## Install
+
+```bash
+pip install git+https://github.com/okforge/okforge@main
+```
+
+## Quick start
+
+```bash
+mkdir my-kb && cd my-kb
+okforge init          # scaffold raw/, wiki/, .openkb/  (--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
+```
+
+Non-Markdown, non-PDF inputs (docx, pptx, scans, photo catalogs, …)
+need converting to Markdown first, by a tool that understands your
+material — a page-aware OCR script, for example. A sibling
+`<doc>.pages.json` page array is what enables real `(p. N)` citations
+in the generated summaries.
+
+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 `.openkb/config.yaml` (model, language, entity
+types, …) and `~/.config/openkb/global.yaml` (KB registry, default
+KB). The LLM endpoint is configured litellm-style — any
+OpenAI-compatible server works, including a local llama.cpp instance.
+
+### Topic tree (experimental, per-KB opt-in)
+
+For knowledge bases that outgrow a flat concept list: set
+`topic_tree: true` in `.openkb/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
+
+```bash
+uv run --extra dev python -m pytest tests/   # test suite
+uv run --extra dev ruff check openkb tests   # lint
+uv run --extra dev ruff format openkb tests  # format
+```
+
+## Origins
+
+okforge began as a hard fork of [VectifyAI/OpenKB](https://github.com/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](https://github.com/okforge/okforge).

okforge-0.6.2/README.md

@@ -0,0 +1,103 @@
+# 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)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) —
+typed frontmatter, relative links, a predictable directory layout — so
+the wiki a KB produces is portable, not locked to okforge itself.
+
+## Install
+
+```bash
+pip install git+https://github.com/okforge/okforge@main
+```
+
+## Quick start
+
+```bash
+mkdir my-kb && cd my-kb
+okforge init          # scaffold raw/, wiki/, .openkb/  (--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
+```
+
+Non-Markdown, non-PDF inputs (docx, pptx, scans, photo catalogs, …)
+need converting to Markdown first, by a tool that understands your
+material — a page-aware OCR script, for example. A sibling
+`<doc>.pages.json` page array is what enables real `(p. N)` citations
+in the generated summaries.
+
+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 `.openkb/config.yaml` (model, language, entity
+types, …) and `~/.config/openkb/global.yaml` (KB registry, default
+KB). The LLM endpoint is configured litellm-style — any
+OpenAI-compatible server works, including a local llama.cpp instance.
+
+### Topic tree (experimental, per-KB opt-in)
+
+For knowledge bases that outgrow a flat concept list: set
+`topic_tree: true` in `.openkb/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
+
+```bash
+uv run --extra dev python -m pytest tests/   # test suite
+uv run --extra dev ruff check openkb tests   # lint
+uv run --extra dev ruff format openkb tests  # format
+```
+
+## Origins
+
+okforge began as a hard fork of [VectifyAI/OpenKB](https://github.com/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](https://github.com/okforge/okforge).