# wikix **Repository Path**: caoyuhaocarl/wikix ## Basic Information - **Project Name**: wikix - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2026-07-19 - **Last Updated**: 2026-08-29 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![wikix banner](assets/wikix-banner.png) # wikix

License: MIT LLM maintained Obsidian ready Wechat: caoyuhaocarl

🇺🇸 English · 🇨🇳 简体中文 · 🇯🇵 日本語 · 🇰🇷 한국어

> 一个由 LLM 维护的个人 wiki:你负责取舍和策展,agent 负责整理、记录和持续累积。 基于 Karpathy 的 LLM Wiki 模式([原始 gist](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) · [本地副本](meta/karpathy-llm-wiki.md))。你把来源材料放进 `raw/`,围绕不断增长的 wiki 提问,然后让 agent 把可长期复用的结果整理成结构化页面:摘要、概念、实体、综合分析、已保存问题、交叉引用和矛盾记录。 当前架构使用双输入流水线:raw 来源和有价值的 query session 都会经过分析、用户对齐、wiki 写入和 review。这样既保持系统简单,也让 wiki 不只靠新增来源增长,而是在使用过程中持续变好。 ## 演示视频 [![wikix 演示视频预览图](assets/demo-cover.jpg)](https://www.bilibili.com/video/BV1pfL26VE4F) 想先看真实使用流程,可以点击预览图,或打开:[我和我 agent 真实分享:如何实现知识复利](https://www.bilibili.com/video/BV1pfL26VE4F)(B站)。 ## 快速开始 1. Clone 这个仓库,并用 [Claude Code](https://claude.com/claude-code)、[Codex](https://openai.com/codex/)、[OpenCode](https://opencode.ai/download)、[Hermes](https://hermes-agent.nousresearch.com/) 或 [OpenClaw](https://openclaw.ai/) 打开。 可复制的命令示例: ```bash git clone https://github.com/CaoYuhaoCarl/wikix.git cd wikix cp USER.md.example USER.md ## 可选:创建本地个人偏好(输出语言、回复风格、术语);USER.md 默认被 Git 忽略 claude ## 可根据自己的情况改成 codex、opencode、hermes 或 openclaw ``` `USER.md` 这一步是可选的。它让 agent 按照你的个人偏好工作——输出语言、回复风格和术语——同时不会把这些个人设置带进共享提交。 2. 把来源文件放进 `raw/`(例如 markdown 文章、论文、PDF、访谈稿、PNG/JPG 图片等)。这个目录会通过占位文件提交到仓库,但你的来源文件默认只保存在本地。 3. 粘贴这段提示词: ``` You're now my LLM wiki agent. Follow the operating schema for this repo. If your runtime has not already loaded the full schema, read AGENTS.md. Ingest the new file in raw/ following the ingest workflow, then update index.md and log.md. ``` 4. 对于有价值的对话,可以运行 `/distill`,或接受 agent 主动提出的保存建议。 agent 会先在 `wiki/_analysis/sessions/` 下创建 session packet,然后在写入正式 wiki 页面前和你确认范围。 5. 在 `wiki/` 中浏览生成的页面。每次 ingest 或 distill 后,都可以用 [Obsidian](https://obsidian.md) 打开仓库查看知识图谱;更推荐的方式是安装 Obsidian 第三方插件市场里的 Claudian,可以直接在 Obsidian 中打开 Claude Code、 Codex 或 OpenCode。这样可以一边 ingest、query、lint,一边看到动态、实时更新的知识图谱。 ![在 Obsidian 中查看 wikix 知识图谱并使用 Claudian](assets/obsidian-claudian-graph.png) **想在另一个项目里从零开始?** 把 [AGENTS.md](AGENTS.md)、你需要的运行时入口和 agent 定义([CLAUDE.md](CLAUDE.md)、[GEMINI.md](GEMINI.md)、[.claude/agents/](.claude/agents/)、[.codex/agents/](.codex/agents/))、[meta/templates/](meta/templates/)、[USER.md.example](USER.md.example) 和 [meta/karpathy-llm-wiki.md](meta/karpathy-llm-wiki.md) 复制到一个空目录,然后告诉你的 agent:*"Implement this idea file as my second brain. Set up the schema, `index.md`, `log.md`, and folder conventions."* ## 目录结构 ```text raw/ # 不可变来源输入;默认只提交 raw/.gitkeep assets/ # 属于 raw 来源的下载资产 wiki/ # LLM 生成的知识层;默认被 Git 忽略 _analysis/ # 流水线产物,不是正式的持久 wiki 知识 sessions/ # /distill 生成的 query-session packet reviews/ # 可选的 reviewer 报告 sources/ # 每个已摄取 raw 来源对应一篇笔记 concepts/ # 可复用的主题页面 entities/ # 人物、组织、项目、工具 syntheses/ # 跨来源分析与结论 questions/ # 对重要问题的已保存回答 attachments/ # wiki 自有或生成的资产 docs/ # 用户和维护者文档 adr/ # 架构决策记录 plans/ # 实施计划和维护笔记 meta/ templates/ # 正式 wiki 页面模板 karpathy-llm-wiki.md # 来源模式的本地副本 assets/ # README 图片和公开媒体 .claude/ agents/ # Claude analyst/builder/reviewer 子代理 skills/wiki-query/ # 项目本地 query citation 辅助技能 .codex/agents/ # Codex analyst/builder/reviewer agent 定义 .obsidian/ # 可移植 vault 设置;workspace/plugin 状态被忽略 index.md # 本地内容目录(每次查询先读它) log.md # 本地只追加的时间顺序活动日志 AGENTS.md # 唯一权威运行规范 CLAUDE.md / GEMINI.md # 运行时兼容入口 -> AGENTS.md USER.md.example # 可选本地偏好模板;复制为 USER.md README*.md # 多语言项目文档 ``` ## 工作流 agent 遵循 [AGENTS.md](AGENTS.md) 中定义的同一条 analyst-builder-reviewer 流水线: ```text raw source ┐ ├─> wiki-analyst -> 用户对齐 -> wiki-builder -> wiki-reviewer query session ┘ ``` - **Ingest** — 阅读新的 `raw/` 来源,分析实体、概念、论点、矛盾和相关页面,然后只在你确认范围后写入。 - **Query** — 回答问题时先读 `index.md`,再深入相关 wiki 页面;只有在需要时才回到 raw 来源核查。 - **Distill** — 把有价值的对话转成 `wiki/_analysis/sessions/` 下的 query-session packet,再把持久结果保存到 `wiki/questions/`、`wiki/syntheses/`、`wiki/concepts/` 或 `wiki/entities/`。 - **Lint** — 健康检查 wiki:孤立页面、断链、矛盾、过期表述、缺失页面。 - **Mastery** — 只有当某个已 distill 的问题或综合分析值得生成更重的 SeedX 式学习产物时,才使用 `/mastery`。`mastery_candidate: true` 只是信号,不会自动生成内容。 架构原因以及和传统方案的对比,见 [docs/dual-input-wiki-pipeline.md](docs/dual-input-wiki-pipeline.md) 和 [ADR 0001](docs/adr/0001-dual-input-wiki-pipeline.md)。实施计划和维护笔记位于 [docs/plans/](docs/plans/)。 ## 约定 - 文件和文件夹使用小写 `kebab-case`。 - 每个 wiki 页面都有 YAML frontmatter(`title`、`type`、`created`、`updated`、`sources`、`tags`)。 - 原始来源不可变。agent 永远不编辑 `raw/` 中的文件。 - `wiki/_analysis/` 存放流水线产物,不是正式的持久 wiki 页面。 - 证据按强度标注:raw/source evidence、existing wiki evidence、user-provided claim、assistant inference。 - agent 在写入正式 wiki 页面前会先和你对齐重点与范围。 完整 schema、工作流规则和证据规则见 [AGENTS.md](AGENTS.md)。页面模板位于 [meta/templates/](meta/templates/)。 ## 致谢 模式来自 Andrej Karpathy — [原始 gist](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f)(本地副本位于 [meta/karpathy-llm-wiki.md](meta/karpathy-llm-wiki.md))。 同时感谢 [Obsidian](https://github.com/obsidianmd/obsidian-releases) 提供本地知识图谱体验,以及 [Claudian](https://github.com/yishentu/claudian) 把 agent 工作流带进 Obsidian。 ## 许可证 [MIT](LICENSE) — 覆盖本仓库中的 schema、模板和工具(`AGENTS.md`、`CLAUDE.md`、`GEMINI.md`、`README*.md`、`docs/`、`meta/` 等)。 注意:你放入 `raw/` 的文件保留其原始许可证,并且默认被 Git 忽略;只提交 `raw/.gitkeep`,这样 clone 后目录仍然存在。agent 在 `wiki/` 中生成的页面是这些来源的衍生作品,会继承对应的许可证义务。如果你发布生成的 wiki 页面,请先核查相应的本地来源和许可证条款。