OpenKB: Open LLM Knowledge Base
LLM wiki kitOfficial PageIndex project
Created by PageIndex
Published in VectifyAI/OpenKB. Publisher page
4,864 GitHub stars
What it is
OpenKB: Open LLM Knowledge Base
AutoGineer overview, from the brain’s own files
OpenKB is an open-source system designed to transform raw documents into a structured, interlinked knowledge base. Unlike traditional RAG systems that re-derive knowledge on every query, OpenKB compiles documents into a persistent wiki foundation. It uses PageIndex for vectorless, reasoning-based retrieval, which allows it to handle long documents by processing them into hierarchical tree indexes. The system maintains summaries, concept pages, and entity pages, ensuring that knowledge compounds over time. It supports a wide range of file formats and integrates with various LLM providers via LiteLLM. OpenKB also includes a Skill Factory for distilling portable agent skills, a web-based Knowledge Workbench, and produces Obsidian-compatible markdown files.
How it works
Memory model: LLM wiki
AutoGineer overview, from the brain’s own files
OpenKB functions by ingesting raw documents like PDFs, Word files, or URLs and converting them into a structured wiki of markdown files. For short documents, it generates summaries and concepts directly. For long documents, it uses PageIndex to create a hierarchical tree index that the LLM reads instead of the full text. This wiki foundation is then used by generators to perform queries, conduct multi-turn chats, visualize knowledge graphs, or distill redistributable agent skills. The system keeps the wiki in sync as new documents are added and provides a CLI for managing the knowledge base.
| Folder | Role | Files |
|---|---|---|
| .github | agent-config | 2 |
| assets | attachments | 1 |
| docs | docs | 2 |
| examples | examples | 31 |
| skills | agent-instructions | 6 |
| tests | tests | 63 |
| .claude-plugin | folder | 1 |
| frontend | folder | 120 |
| openkb | folder | 58 |
The agent reads
- examples/chat/ evidence: README.md
- AGENTS.md evidence: README.md
Requirements
Runtimes: Python >=3.10
API keys (by name): LLM_API_KEY, OPENKB_API_TOKEN, PAGEINDEX_API_KEY
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Google Antigravity, Kiro, OpenCode, Amp, Roo Code, Cline, JetBrains Junie, Devin (ex-Windsurf)
Set it up
Clone the repository at the commit AutoGineer scanned:
git clone https://github.com/VectifyAI/OpenKB.git && cd OpenKB && git checkout ff54396e575ee6feb0113b631a34caa082b441ccClaude Code reads CLAUDE.md from this folder automatically.
cd OpenKB && claude
AutoGineer scanned these files at commit ff54396.
- Not scanned by AutoGineerThe author’s README also describes installing it from a clone of its repository. Read its install section: AutoGineer did not scan that path. https://github.com/VectifyAI/OpenKB/blob/ff54396e575ee6feb0113b631a34caa082b441cc/README.md#install
- Not scanned by AutoGineerIts dependencies are installed by pip or uv when you run it and were not scanned by AutoGineer (14 declared). https://pypi.org/project/openkb/
Created by PageIndex. Published in VectifyAI/OpenKB. Licence: Apache License 2.0.
Usage
AutoGineer overview, from the brain’s own files
- Initialize a new knowledge base with openkb init
- Add documents or directories to the KB using openkb add
- Query the knowledge base for grounded answers using openkb query
- Start an interactive chat session over the wiki with openkb chat
- Distill a portable agent skill from the wiki using openkb skill new
- Generate a slide deck from the wiki content using openkb deck new
- “openkb query "What are the main findings of the uploaded research papers?"”
- The agent provides a grounded, cited answer based on the synthesized summaries and concept pages in the wiki.
- “openkb skill new expert-analyst "Reason like a senior data analyst on the current project"”
- The system distills a portable agent skill folder that can be loaded by other agents like Claude Code or Codex.
Documentation by PageIndex
<div align="center">
<a href="https://openkb.ai"> <img src="https://docs.pageindex.ai/images/openkb.png" alt="OpenKB (by PageIndex)" /> </a>
<br /> <br />
<p align="center"> <a href="https://trendshift.io/repositories/26145" target="_blank"><img src="https://trendshift.io/api/badge/repositories/26145" alt="VectifyAI%2FOpenKB | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> </p>
OpenKB: Open LLM Knowledge Base
<p align="center"><i>Scale to long documents • Reasoning-based retrieval • Native multi-modality • No Vector DB</i></p>
</div>
<details open> <summary><h2>📢 Recent Updates</h2></summary>
Google Open Knowledge Format (OKF): Wiki pages follow the Google OKF specification for knowledge sharing.
Entity Pages: People, orgs, places, and products as dedicated wiki pages, auto-extracted and kept in sync.
</details>
📑 What is OpenKB
OpenKB (Open Knowledge Base) is an open-source system (in CLI) that compiles raw documents into a structured, interlinked wiki-style knowledge base using LLMs, powered by PageIndex's vectorless, reasoning-based retrieval for long documents.
The idea is based on a concept described by Andrej Karpathy: LLMs generate summaries, concept pages, and cross-references, all maintained automatically. Knowledge compounds over time instead of being re-derived on every query.
Why not traditional RAG?
Traditional RAG rediscovers knowledge from scratch on every query. Nothing accumulates. OpenKB compiles knowledge once into a persistent wiki, then keeps it current. Cross-references already exist, contradictions are flagged, and synthesis reflects everything consumed.
OpenKB has two layers: a wiki foundation that compiles and maintains your knowledge, and generators (query / chat / Skill Factory) that turn it into useful output. See Usage for the full command list.
Features
Broad format support: PDF, Word, Markdown, PowerPoint, HTML, Excel, CSV, text, URLs, and more.
Scales to long documents: Long and complex documents are handled via PageIndex tree indexing, enabling accurate, vectorless, context-aware retrieval.
Native multi-modality: Retrieves and understands figures, tables, and images, not just text.
Compiled wiki: The LLM compiles your documents into summaries, concept pages, entity pages, and cross-links, all kept in sync.
Query & chat: One-off questions or multi-turn conversations over your wiki, with persisted sessions to resume.
Skill Factory: Distills redistributable agent skills from your wiki.
OKF-ready: Wiki pages follow the Google OKF specification for knowledge sharing.
Obsidian-compatible: The wiki is plain
.mdfiles with cross-links. Opens in Obsidian for graph view.Knowledge Workbench (Web UI): A bundled web UI served at
/to browse the KB, upload and compile documents, and stream queries and chats — all in the browser.
🚀 Getting Started
Install
pip install openkb<details> <summary><b><i>Other install options:</i></b></summary>
Latest from GitHub:
pip install git+https://github.com/VectifyAI/OpenKB.gitInstall from source (editable, for development):
git clone https://github.com/VectifyAI/OpenKB.git cd OpenKB pip install -e .
</details>
Quick Start
# 1. Create a directory for your knowledge base
mkdir my-kb && cd my-kb
# 2. Initialize the knowledge base
openkb init
# 3. Add documents
openkb add paper.pdf
openkb add ~/papers/ # Add a whole directory
openkb add https://arxiv.org/pdf/2509.11420 # Or fetch from a URL
# 4. Ask a question
openkb query "What are the main findings?"
# 5. Or chat interactively
openkb chat
# (Optional) Turn the wiki into other outputs
openkb skill new my-expert "Reason like an expert on <your-topic>" # a portable agent skill
openkb visualize # an interactive knowledge graph
openkb deck new my-deck "An intro deck on <your-topic>" # slides — a single-file HTML deckSet up your LLM
OpenKB supports multiple LLM providers (OpenAI, Claude, Gemini, etc.) via LiteLLM (pinned to a safe version).
Set your model during openkb init or in .openkb/config.yaml using the provider/model LiteLLM format (e.g. anthropic/claude-sonnet-4-6). OpenAI models can omit the prefix (e.g. gpt-5.4).
Create a .env file with your LLM API key:
LLM_API_KEY=your_llm_api_keySubscription-based providers that authenticate via OAuth device flow (e.g. chatgpt/*, github_copilot/*) need no API key; OpenKB skips the missing-key warning for them.
Knowledge Workbench (Web UI)
OpenKB ships a bundled web UI, served by the REST API at /. Install the API extra and start the server — no configuration needed:
pip install "openkb[web]"
openkb-web # serves the API + Workbench at http://127.0.0.1:7566/Open http://127.0.0.1:7566/ for the Workbench. Auth is off by default (local-first); set OPENKB_API_TOKEN to require a bearer token before exposing the server. See the full Web UI guide.
Working on the UI itself? Run the Vite dev server with
cd frontend && npm install && npm run dev(it proxies/apito a runningopenkb-web), ornpm run buildto regenerate the bundledopenkb/web/.
🧩 How OpenKB Works
Architecture
<div align="center"> <img src="assets/openkb-architecture.webp" alt="OpenKB Architecture: from raw documents (markitdown / PageIndex) through LLM wiki compilation to the wiki/ foundation, powering query/chat, the Skill Factory, and future generators" width="900" /> </div>
Short vs Long Document Handling
| Short documents | Long documents (PDF ≥ 20 pages) | |
|---|---|---|
| Convert | markitdown → Markdown | PageIndex → tree index + summaries |
| Images | Extracted inline (pymupdf) | Extracted by PageIndex |
| LLM reads | Full text | Document trees |
| Result | summary + concepts | summary + concepts |
Short documents are read in full by the LLM. Long PDFs are processed by PageIndex into a hierarchical tree index. The LLM reads the tree instead of the full text, enabling accurate and scalable retrieval for long documents.
Knowledge Compilation
When you add a document, the LLM:
Generates a summary page
Reads existing concept and entity pages
Creates or updates concepts with cross-document synthesis
Creates or updates entity pages (people, orgs, places, products)
Updates the index and log
A single source might touch 10--15 wiki pages. Knowledge accumulates: each document enriches the existing wiki rather than sitting in isolation.
⚙️ Usage
OpenKB commands fall into two layers: the wiki foundation (compile + manage your knowledge) and generators (turn that wiki into useful output). Each links to a concrete walkthrough — a real artifact OpenKB generated from one sample paper (browse them all in examples/).
Layer 1: 🧱 Wiki Foundation — compile and maintain
| Command | Description |
|---|---|
openkb init | Initialize a new knowledge base (interactive) |
| <code>openkb add <file_or_dir_or_URL></code> | Add files, directories, or URLs and compile to wiki (URL content type is auto-detected) |
openkb list | List indexed documents and concepts |
openkb status | Show knowledge base stats |
openkb watch | Watch raw/ and auto-compile new files |
openkb lint | Run structural and knowledge health checks |
<details> <summary><i>More wiki commands:</i></summary> <br>
| Command | Description |
|---|---|
| <code>openkb remove <doc></code> | Remove a document and clean up its wiki pages, images, registry, and PageIndex state (--dry-run to preview, --keep-raw / --keep-empty to retain artifacts) |
| <code>openkb recompile [<doc>] [--all]</code> | Re-run the compile pipeline on already-indexed docs without re-indexing. Regenerates summaries and rewrites concept pages; manual edits are overwritten (--dry-run to preview, --refresh-schema to also update wiki/AGENTS.md) |
| <code>openkb feedback ["msg"]</code> | File feedback by opening a prefilled GitHub issue (--type bug/feature/question to tag it) |
</details>
→ Example: the everyday loop walked through end to end — examples/commands/.
Layer 2: 💡 Generators — turn the wiki into output
A "generator" reads from the compiled wiki and produces something usable: an answer, a conversation, a skill folder. The wiki is the substrate; generators are the surfaces.
| Command | Output | Example |
|---|---|---|
| <code>openkb query "question"</code> | A grounded answer with citations (--save to persist to wiki/explorations/) | query & save |
| <code>openkb chat</code> | Interactive multi-turn session over the wiki (--resume, --list, --delete to manage sessions) | chat |
| <code>openkb visualize</code> | A self-contained interactive knowledge graph at output/visualize/graph.html — 3D, mind-map, and radial views | visualize |
| <code>openkb skill new <skill-name> "<intent>"</code> | Distill a redistributable agent skill from your wiki (see Skill Factory below) | skills |
| <code>openkb deck new <name> "<intent>"</code> | Generate a single-file HTML slide deck (--skill picks a theme, --critique runs a quality pass) | slides |
(i) 💬 Query & Chat — ask the wiki
openkb query "..." answers a single question with a grounded, cited answer from your wiki. openkb chat is interactive, an ongoing multi-turn session over the same wiki (--resume, --list, --delete to manage sessions). → Walked through with real saved output in examples/commands/ (query) and examples/chat/ (chat).
Inside a chat, type / to access slash commands (Tab to complete).
<details> <summary><i>More slash commands:</i></summary> <br>
/help: list available commands/status: show knowledge base status/list: list all documents/add <path>: add a document or directory without leaving the chat/skill new <skill-name> "<intent>": compile a skill from this chat (see below)/deck new <name> "<intent>": generate an HTML slide deck from the wiki/critique <path>: run the HTML critic over an existing deck/save [name]: export the transcript towiki/explorations//clear: start a fresh session (the current one stays on disk)/lint: run knowledge base lint/exit: exit (Ctrl-D also works)
</details>
<a id="skill-factory"></a>
(ii) 🛠 Skill Factory — drop in a book; out comes a digital expert.
openkb skill new distills a portable agent skill from your wiki that Claude Code, Codex, and Gemini can install and load natively. Drop in a book's worth of papers; out comes a specialist other agents can call on. → A real generated skill, plus install / share / eval / rollback, is walked through in examples/skills/.
<details> <summary><i>More skill commands:</i></summary> <br>
| Command | Output |
|---|---|
| <code>openkb skill validate [name]</code> | Validate compiled skills (auto-runs after skill new) |
| <code>openkb skill eval <name></code> | Check the skill triggers on the right prompts |
| <code>openkb skill history <name></code> / <code>openkb skill rollback <name></code> | Version history + rollback for skills |
</details>
🔧 Configuration
Settings
OpenKB settings are initialized by openkb init and stored in .openkb/config.yaml:
model: gpt-5.4 # LLM model (any LiteLLM-supported provider)
language: en # Wiki output language
pageindex_threshold: 20 # PDF pages threshold for PageIndexThe full settings reference — entity_types, OAuth providers (chatgpt/*, github_copilot/*), and LiteLLM tuning (timeouts for slow local runtimes like Ollama / LM Studio, drop_params, GitHub Copilot headers, install notes) — is in examples/configuration/.
PageIndex Setup
Long-document retrieval is a known challenge for LLMs. PageIndex solves this with vectorless, reasoning-based retrieval, by building a hierarchical tree index that lets LLMs reason over the index for context-aware retrieval.
PageIndex runs locally by default using the open-source version, with no external dependencies required.
Cloud Support (Optional):
For large or complex PDFs, PageIndex Cloud can be used to access additional capabilities, including:
OCR support for scanned PDFs (via hosted VLM models)
Faster structure generation
Scalable indexing for large documents
Set PAGEINDEX_API_KEY in your .env to enable cloud features:
PAGEINDEX_API_KEY=your_pageindex_api_key→ Example: local vs. cloud indexing, and importing a cloud-indexed doc — examples/pageindex-cloud/.
AGENTS.md
The wiki/AGENTS.md file defines wiki structure and conventions. It's the LLM's instruction manual for maintaining the wiki. Customize it to change how your wiki is organized.
The LLM reads AGENTS.md from disk at runtime, so your edits take effect immediately.
🔌 Integrations
Using with Obsidian
The wiki is a directory of Markdown files with [[wikilinks]]. Obsidian renders it natively.
Open
wiki/as an Obsidian vaultBrowse summaries, concepts, and explorations
Use graph view to see knowledge connections
Use Obsidian Web Clipper to add web articles to
raw/
Using with Claude Code / Codex / Gemini CLI
OpenKB ships a SKILL.md so any agent can read your compiled wiki. No extra runtime, no MCP setup, just install the skill once.
<details> <summary><i>Claude Code:</i></summary> <br>
/plugin marketplace add VectifyAI/OpenKB
/plugin install openkb@vectify</details>
<details> <summary><i>OpenAI Codex CLI:</i></summary> <br>
(no marketplace command yet; manual symlink)
git clone https://github.com/VectifyAI/OpenKB.git ~/openkb-src
mkdir -p ~/.agents/skills
ln -s ~/openkb-src/skills/openkb ~/.agents/skills/openkb</details>
<details> <summary><i>Gemini CLI:</i></summary> <br>
gemini skills install https://github.com/VectifyAI/OpenKB.git --path skills/openkb --consent</details>
The skill is read-only. It won't run openkb add, remove, or lint --fix without you asking. See skills/openkb/SKILL.md for the full instruction set.
REST API
OpenKB ships a FastAPI service for HTTP clients. Install with pip install -e ".[web]", then start with python -m openkb.api. The interactive API reference is at /docs (importable into Postman).
See the full REST API reference for endpoints, auth, and SSE streaming.
🧭 Learn More
Compared to Karpathy's Approach
| Karpathy's workflow | OpenKB | |
|---|---|---|
| Short documents | LLM reads directly | markitdown → LLM reads |
| Long documents | Context limits, context rot | PageIndex tree index |
| Input sources | Web clipper → .md | PDF, Word, PPT, Excel, HTML, text, CSV, .md, URLs |
| Wiki compilation | LLM agent | LLM agent (same) |
| Entity extraction | Manual | Automatic (people, orgs, places, products) |
| Q&A | Query over wiki | Wiki + PageIndex retrieval |
| Output | Wiki only | Wiki + Skill Factory + agent CLI integration |
The Stack
PageIndex — Vectorless, reasoning-based document indexing and retrieval
markitdown — Universal file-to-markdown conversion
OpenAI Agents SDK — Agent framework (supports non-OpenAI models via LiteLLM)
LiteLLM — Multi-provider LLM gateway
Click — CLI framework
watchdog — Filesystem monitoring
Roadmap
[ ] Extend long document handling to non-PDF formats
[ ] Scale to large document collections with nested folder support
[ ] Hierarchical concept (topic) indexing for massive knowledge bases
[ ] Database-backed storage engine
[x] Web UI for browsing and managing wikis (Knowledge Workbench, served at
/)
Contributing
Contributions are welcome! Submit a pull request or open an issue for bugs and feature requests. For larger changes, consider opening an issue first to discuss the approach.
License
Apache 2.0. See LICENSE.
🌐 Open-Source Ecosystem
Other open-source projects from the PageIndex ecosystem:
PageIndex: Vectorless, reasoning-based RAG framework for long documents
ChatIndex: Tree indexing and retrieval for long conversational histories and memory
ConDB: A KV-cache native context database for tree-based retrieval at scale
PageIndex MCP: MCP server for PageIndex
Support Us
If you find OpenKB useful, please give us a star 🌟 — and check out PageIndex too!
<div>
Image: Twitter  Image: LinkedIn  Image: Contact Us
</div>
LICENSE
Shown as plain text.
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.
294 files · 288 not served here
- .claude-plugin/marketplace.json (not served here)
- .env.example (not served here)
- .github/workflows/ci.yml (not served here)
- .github/workflows/publish.yml (not served here)
- .gitignore (not served here)
- AGENTS.md
- ATTRIBUTION.md
- CLAUDE.md
- LICENSE
- README.md
- assets/openkb-architecture.webp (not served here)
- config.yaml.example (not served here)
- docs/.gitignore (not served here)
- docs/golden-principles.md
- examples/README.md (not served here)
- examples/chat/README.md (not served here)
- examples/commands/README.md (not served here)
- examples/commands/sample-wiki/concepts/attention-mechanisms.md (not served here)
- examples/commands/sample-wiki/concepts/positional-encoding.md (not served here)
- examples/commands/sample-wiki/concepts/transformer-models.md (not served here)
- examples/commands/sample-wiki/entities/google-brain.md (not served here)
- examples/commands/sample-wiki/entities/google-research.md (not served here)
- examples/commands/sample-wiki/entities/google.md (not served here)
- examples/commands/sample-wiki/entities/nips-2017.md (not served here)
- examples/commands/sample-wiki/entities/tensor2tensor.md (not served here)
- examples/commands/sample-wiki/entities/university-of-toronto.md (not served here)
- examples/commands/sample-wiki/entities/wmt-2014-english-french.md (not served here)
- examples/commands/sample-wiki/entities/wmt-2014-english-german.md (not served here)
- examples/commands/sample-wiki/entities/wmt-2014.md (not served here)
- examples/commands/sample-wiki/explorations/how-does-the-transformer-replace-recurrence-with-self-attent.md (not served here)
- examples/commands/sample-wiki/summaries/attention-is-all-you-need.md (not served here)
- examples/configuration/README.md (not served here)
- examples/docs/Bishop-Pattern-Recognition-and-Machine-Learning-2006.pdf (not served here)
- examples/docs/attention-is-all-you-need.pdf (not served here)
- examples/docs/deepseek-r1.pdf (not served here)
- examples/pageindex-cloud/README.md (not served here)
- examples/rest-api/README.md (not served here)
- examples/skills/README.md (not served here)
- examples/skills/marketplace.json (not served here)
- examples/skills/transformer-attention/SKILL.md (not served here)
- examples/skills/transformer-attention/references/original-transformer-paper.md (not served here)
- examples/slides/README.md (not served here)
- examples/slides/attention-intro.html (not served here)
- examples/visualize/README.md (not served here)
- examples/visualize/graph.html (not served here)
- frontend/.gitignore (not served here)
- frontend/components.json (not served here)
- frontend/eslint.config.js (not served here)
- frontend/index.html (not served here)
- frontend/package-lock.json (not served here)
- frontend/package.json (not served here)
- frontend/postcss.config.js (not served here)
- frontend/scripts/check-i18n.mjs (not served here)
- frontend/src/App.css (not served here)
- frontend/src/App.tsx (not served here)
- frontend/src/api/artifacts.ts (not served here)
- frontend/src/api/chat.ts (not served here)
- frontend/src/api/client.ts (not served here)
- frontend/src/api/config.ts (not served here)
- frontend/src/api/kb.ts (not served here)
- frontend/src/api/maintenance.ts (not served here)
- frontend/src/api/meta.ts (not served here)
- frontend/src/api/wiki.ts (not served here)
- frontend/src/components/AboutTab.tsx (not served here)
- frontend/src/components/AppSidebar.tsx (not served here)
- frontend/src/components/ArtifactCard.tsx (not served here)
- frontend/src/components/ArtifactPanel.tsx (not served here)
- frontend/src/components/ChatInput.tsx (not served here)
- frontend/src/components/ConnectorCards.tsx (not served here)
- frontend/src/components/CreateKbDialog.tsx (not served here)
- frontend/src/components/EntityTypesEditor.tsx (not served here)
- frontend/src/components/KbOverviewCards.tsx (not served here)
- frontend/src/components/KbSettingsSheet.tsx (not served here)
- frontend/src/components/MarkdownView.tsx (not served here)
- frontend/src/components/PageList.tsx (not served here)
- frontend/src/components/TitleBar.tsx (not served here)
- frontend/src/components/UnLanguageDatalist.tsx (not served here)
- frontend/src/components/ui/accordion.tsx (not served here)
- frontend/src/components/ui/alert-dialog.tsx (not served here)
- frontend/src/components/ui/alert.tsx (not served here)
- frontend/src/components/ui/aspect-ratio.tsx (not served here)
- frontend/src/components/ui/avatar.tsx (not served here)
- frontend/src/components/ui/badge.tsx (not served here)
- frontend/src/components/ui/breadcrumb.tsx (not served here)
- frontend/src/components/ui/button-group.tsx (not served here)
- frontend/src/components/ui/button.tsx (not served here)
- frontend/src/components/ui/calendar.tsx (not served here)
- frontend/src/components/ui/card.tsx (not served here)
- frontend/src/components/ui/carousel.tsx (not served here)
- frontend/src/components/ui/chart.tsx (not served here)
- frontend/src/components/ui/checkbox.tsx (not served here)
- frontend/src/components/ui/collapsible.tsx (not served here)
- frontend/src/components/ui/command.tsx (not served here)
- frontend/src/components/ui/context-menu.tsx (not served here)
- frontend/src/components/ui/dialog.tsx (not served here)
- frontend/src/components/ui/drawer.tsx (not served here)
- frontend/src/components/ui/dropdown-menu.tsx (not served here)
- frontend/src/components/ui/empty.tsx (not served here)
- frontend/src/components/ui/field.tsx (not served here)
- frontend/src/components/ui/form.tsx (not served here)
- frontend/src/components/ui/hover-card.tsx (not served here)
- frontend/src/components/ui/input-group.tsx (not served here)
- frontend/src/components/ui/input-otp.tsx (not served here)
- frontend/src/components/ui/input.tsx (not served here)
- frontend/src/components/ui/item.tsx (not served here)
- frontend/src/components/ui/kbd.tsx (not served here)
- frontend/src/components/ui/label.tsx (not served here)
- frontend/src/components/ui/menubar.tsx (not served here)
- frontend/src/components/ui/navigation-menu.tsx (not served here)
- frontend/src/components/ui/pagination.tsx (not served here)
- frontend/src/components/ui/popover.tsx (not served here)
- frontend/src/components/ui/progress.tsx (not served here)
- frontend/src/components/ui/radio-group.tsx (not served here)
- frontend/src/components/ui/resizable.tsx (not served here)
- frontend/src/components/ui/scroll-area.tsx (not served here)
- frontend/src/components/ui/select.tsx (not served here)
- frontend/src/components/ui/separator.tsx (not served here)
- frontend/src/components/ui/sheet.tsx (not served here)
- frontend/src/components/ui/sidebar.tsx (not served here)
- frontend/src/components/ui/skeleton.tsx (not served here)
- frontend/src/components/ui/slider.tsx (not served here)
- frontend/src/components/ui/sonner.tsx (not served here)
- frontend/src/components/ui/spinner.tsx (not served here)
- frontend/src/components/ui/switch.tsx (not served here)
- frontend/src/components/ui/table.tsx (not served here)
- frontend/src/components/ui/tabs.tsx (not served here)
- frontend/src/components/ui/textarea.tsx (not served here)
- frontend/src/components/ui/toggle-group.tsx (not served here)
- frontend/src/components/ui/toggle.tsx (not served here)
- frontend/src/components/ui/tooltip.tsx (not served here)
- frontend/src/hooks/use-mobile.ts (not served here)
- frontend/src/hooks/useAnimatedSwitch.ts (not served here)
- frontend/src/index.css (not served here)
- frontend/src/lib/i18n.ts (not served here)
- frontend/src/lib/language.tsx (not served here)
- frontend/src/lib/languages.ts (not served here)
- frontend/src/lib/theme.tsx (not served here)
- frontend/src/lib/utils.ts (not served here)
- frontend/src/locales/en/artifacts.json (not served here)
- frontend/src/locales/en/chat.json (not served here)
- frontend/src/locales/en/common.json (not served here)
- frontend/src/locales/en/home.json (not served here)
- frontend/src/locales/en/kb.json (not served here)
- frontend/src/locales/en/kbList.json (not served here)
- frontend/src/locales/en/kbSettings.json (not served here)
- frontend/src/locales/en/settings.json (not served here)
- frontend/src/locales/zh/artifacts.json (not served here)
- frontend/src/locales/zh/chat.json (not served here)
- frontend/src/locales/zh/common.json (not served here)
- frontend/src/locales/zh/home.json (not served here)
- frontend/src/locales/zh/kb.json (not served here)
- frontend/src/locales/zh/kbList.json (not served here)
- frontend/src/locales/zh/kbSettings.json (not served here)
- frontend/src/locales/zh/settings.json (not served here)
- frontend/src/main.tsx (not served here)
- frontend/src/pages/ChatSession.tsx (not served here)
- frontend/src/pages/Home.tsx (not served here)
- frontend/src/pages/KbDetail.tsx (not served here)
- frontend/src/pages/KbList.tsx (not served here)
- frontend/src/pages/Settings.tsx (not served here)
- frontend/tailwind.config.js (not served here)
- frontend/tsconfig.app.json (not served here)
- frontend/tsconfig.json (not served here)
- frontend/tsconfig.node.json (not served here)
- frontend/vite.config.ts (not served here)
- openkb/__init__.py (not served here)
- openkb/__main__.py (not served here)
- openkb/add_coordinator.py (not served here)
- openkb/agent/__init__.py (not served here)
- openkb/agent/_markdown.py (not served here)
- openkb/agent/chat.py (not served here)
- openkb/agent/chat_session.py (not served here)
- openkb/agent/compiler.py (not served here)
- openkb/agent/linter.py (not served here)
- openkb/agent/query.py (not served here)
- openkb/agent/skill_runner.py (not served here)
- openkb/agent/skills.py (not served here)
- openkb/agent/tools.py (not served here)
- openkb/api.py (not served here)
- openkb/api_config.py (not served here)
- openkb/api_config_router.py (not served here)
- openkb/api_documents_router.py (not served here)
- openkb/api_graph.py (not served here)
- openkb/api_helpers.py (not served here)
- openkb/api_kbs.py (not served here)
- openkb/api_kbs_router.py (not served here)
- openkb/api_models.py (not served here)
- openkb/api_output.py (not served here)
- openkb/api_pages_router.py (not served here)
- openkb/cli.py (not served here)
- openkb/config.py (not served here)
- openkb/converter.py (not served here)
- openkb/deck/__init__.py (not served here)
- openkb/deck/creator.py (not served here)
- openkb/deck/validator.py (not served here)
- openkb/documents.py (not served here)
- openkb/frontmatter.py (not served here)
- openkb/images.py (not served here)
- openkb/indexer.py (not served here)
- openkb/kb_admin.py (not served here)
- openkb/lint.py (not served here)
- openkb/locks.py (not served here)
- openkb/log.py (not served here)
- openkb/mutation.py (not served here)
- openkb/page_ops.py (not served here)
- openkb/prompts/__init__.py (not served here)
- openkb/prompts/skill_create.md (not served here)
- openkb/schema.py (not served here)
- openkb/skill/__init__.py (not served here)
- openkb/skill/creator.py (not served here)
- openkb/skill/evaluator.py (not served here)
- openkb/skill/generator.py (not served here)
- openkb/skill/marketplace.py (not served here)
- openkb/skill/tools.py (not served here)
- openkb/skill/validator.py (not served here)
- openkb/skill/workspace.py (not served here)
- openkb/state.py (not served here)
- openkb/templates/graph.html (not served here)
- openkb/tree_renderer.py (not served here)
- openkb/url_ingest.py (not served here)
- openkb/visualize.py (not served here)
- openkb/watch_service.py (not served here)
- openkb/watcher.py (not served here)
- pyproject.toml (not served here)
- skills/openkb-deck-editorial/SKILL.md (not served here)
- skills/openkb-deck-neon/SKILL.md (not served here)
- skills/openkb-html-critic/SKILL.md (not served here)
- skills/openkb/SKILL.md (not served here)
- skills/openkb/references/commands.md (not served here)
- skills/openkb/references/wiki-schema.md (not served here)
- tests/conftest.py (not served here)
- tests/test_add_command.py (not served here)
- tests/test_agent_tools.py (not served here)
- tests/test_api.py (not served here)
- tests/test_api_documents.py (not served here)
- tests/test_api_watch.py (not served here)
- tests/test_chat_session.py (not served here)
- tests/test_chat_slash_commands.py (not served here)
- tests/test_cli.py (not served here)
- tests/test_compiler.py (not served here)
- tests/test_config.py (not served here)
- tests/test_converter.py (not served here)
- tests/test_critique_slash.py (not served here)
- tests/test_cross_platform_locks.py (not served here)
- tests/test_deck_chat_slash.py (not served here)
- tests/test_deck_cli.py (not served here)
- tests/test_deck_creator.py (not served here)
- tests/test_deck_neon_prompt.py (not served here)
- tests/test_deck_package.py (not served here)
- tests/test_deck_prompt.py (not served here)
- tests/test_deck_validator.py (not served here)
- tests/test_feedback.py (not served here)
- tests/test_file_size.py (not served here)
- tests/test_frontmatter.py (not served here)
- tests/test_generator.py (not served here)
- tests/test_images.py (not served here)
- tests/test_indexer.py (not served here)
- tests/test_lint.py (not served here)
- tests/test_lint_cli.py (not served here)
- tests/test_linter.py (not served here)
- tests/test_list_status.py (not served here)
- tests/test_llm_config_passthrough.py (not served here)
- tests/test_llm_timeout.py (not served here)
- tests/test_locks.py (not served here)
- tests/test_markdown_renderer.py (not served here)
- tests/test_marketplace.py (not served here)
- tests/test_mutation.py (not served here)
- tests/test_per_request_overrides.py (not served here)
- tests/test_query.py (not served here)
- tests/test_read_kb_file.py (not served here)
- tests/test_recompile.py (not served here)
- tests/test_remove.py (not served here)
- tests/test_save_exploration.py (not served here)
- tests/test_schema.py (not served here)
- tests/test_skill_chat_slash.py (not served here)
- tests/test_skill_cli.py (not served here)
- tests/test_skill_creator.py (not served here)
- tests/test_skill_evaluator.py (not served here)
- tests/test_skill_name_validation.py (not served here)
- tests/test_skill_runner.py (not served here)
- tests/test_skill_tools.py (not served here)
- tests/test_skill_validator.py (not served here)
- tests/test_skill_workspace.py (not served here)
- tests/test_skills.py (not served here)
- tests/test_state.py (not served here)
- tests/test_stream_disconnect.py (not served here)
- tests/test_tree_renderer.py (not served here)
- tests/test_url_ingest.py (not served here)
- tests/test_visualize.py (not served here)
- tests/test_visualize_cli.py (not served here)
- tests/test_watch_service.py (not served here)
- tests/test_watcher.py (not served here)
- tests/test_write_kb_file.py (not served here)
- uv.lock (not served here)
Advantages
- Knowledge compounds over time as the LLM synthesizes new documents into existing concept and entity pages. evidence: README.md
- Handles long and complex documents accurately using hierarchical tree indexing instead of traditional vector search. evidence: README.md
Limitations
- Manual edits to compiled wiki pages are overwritten when the recompile command is run. evidence: README.md
- Requires specific dependency pinning to maintain stability and security against supply-chain risks. evidence: pyproject.toml
Security
Risk level: Low risk
This brain runs
Agent instructions that run or fetch something (17)
AGENTS.md:This repo is developed **agent-first**: humans steer, agents execute.AGENTS.md:Install: `pip install -e ".[dev]"` (or `uv sync --extra dev` — plain `uv sync` skips the dev tools)AGENTS.md:Run CLI: `openkb <command>` (entry point: `openkb.cli:cli`)AGENTS.md:`state.py` — run/session state tracking.skills/openkb-deck-editorial/SKILL.md:Vary `data-type` — at least 4 distinct types, no run of 3+ consecutive same type.skills/openkb-deck-editorial/SKILL.md:Is there no run of 3+ consecutive slides with the same `data-type`?skills/openkb-deck-editorial/SKILL.md:If any answer is no, revise and re-run this self-check.skills/openkb-deck-neon/SKILL.md:if labels run long or there are many, use a VERTICAL stack of full-width rows, never a cramped horizontal graph.skills/openkb-deck-neon/SKILL.md:Vary types — ≥4 distinct, no run of 3+ consecutive same type.skills/openkb-deck-neon/SKILL.md:At least 4 distinct `data-type` values, no run of 3+ same?skills/openkb-deck-neon/SKILL.md:If any answer is no, revise and re-run this self-check.skills/openkb-html-critic/SKILL.md:If the deck uses `data-type` attributes, no run of 3+ consecutive same-type slides (visual monotony failure).skills/openkb/SKILL.md:Run `openkb status` to discover the KB root and a summary in one call:skills/openkb/SKILL.md:If `openkb status` says "No knowledge base found", tell the user to `cd` into their KB or run `openkb init` to create one — don't proceed.skills/openkb/SKILL.md:If `jq` isn't available in your environment, fall back to a Python one-liner: `python3 -c "import json,sys;skills/openkb/SKILL.md:If a user request would benefit from one of these, propose the exact command with what it does, and let the user run it.skills/openkb/SKILL.md:Run it when you're ready."
- Low risk: network-instructions (AGENTS.md:13)
- Low risk: network-instructions (pyproject.toml:80)
Attribution and licence
- Created by
- PageIndex
- Declared authors
- Kylin (declared in pyproject.toml)
- Publisher
- PageIndex (Official PageIndex project)
- Source
- VectifyAI/OpenKB · commit ff54396
- Licence
- Apache License 2.0 (files served here)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by PageIndex.
Install from source
288 of its files are not served here, so there is no ZIP. VectifyAI/OpenKB at ff54396