内容
# llmkb — 本地、文件夹优先的LLM知识库
一个用于LLM知识库的模板和工具包，它只是一个markdown页面的git目录，以Karpathy的LLM-wiki风格呈现。一个代理加上该目录是一个完整的系统：代理摄取来源并记录它们学到的内容，维基随着时间的推移不断完善，一个小型CLI保持记录的诚实。无需服务器，无需数据库，无需专有格式。
此仓库提供了**格式规范、CLI、可选的MCP服务器和代理技能**。实际的知识库是单独的目录，按项目生成 - 此仓库永远不会包含任何人的知识。
## 安装
uv tool install llmkb # 或：pipx install llmkb
# 可选的MCP服务器：
uv tool install "llmkb[mcp]"
## 快速开始
llmkb init my-project-kb --description "我的项目笔记"
# 将来源放入 my-project-kb/raw/，然后使用 kb-ingest 技能
llmkb reindex --kb my-project-kb
llmkb lint --kb my-project-kb
llmkb search "一些查询" --kb my-project-kb
## 知识库的内容
知识库是一个目录：
my-project-kb/
kb.yaml # 身份 + 格式版本
SCHEMA.md # 代理遵循的写作规范
raw/ # 精选来源，永不修改
wiki/
summaries/ concepts/ entities/
index.md # 派生目录（llmkb reindex 重建它）
log.md # 追加操作记录
参见 `docs/FORMAT.md` 以获取完整的版本化合约，并参见 `examples/example-kb/` 以获取一个工作示例。
## CLI
- `llmkb init <dir>` — 搭建一个新的知识库。
- `llmkb reindex` — 从页面前置信息重建 `wiki/index.md`。
- `llmkb lint` — 捕获损坏的链接、孤立页面、索引漂移、格式错误的前置信息；退出代码反映健康状态。
- `llmkb search <query>` — 全文搜索（SQLite FTS5，缓存在 `.llmkb/`）。
所有命令都接受 `--kb <dir>` （可重复；默认为当前目录），并按名称标记多知识库输出。
## MCP 服务器（可选）
`llmkb-mcp --kb <dir>` 运行一个只读MCP_stdio服务器，向任何MCP-capable代理公开 `search`、`get_page`、`get_index` 和 `list_kbs`。
## 技能
四个可移植的、双重适应的技能位于 `skills/` — `kb-ingest`、`kb-query`、`kb-lint`、`kb-init`。安装它们一次（全局或作为插件）；永远不要将它们复制到知识库实例中，以便它们集中演化。
## 许可证
Apache-2.0. 参见 `LICENSE`。
