快速开始 (Getting started)
中文 (简体) 翻译 — 以英文主文档
docs/getting-started.md为准 上次同步：v0.3.0 (2026-04-08) v0.3 初稿 — 本翻译为初版，可能落后于英文主文档。
5 分钟快速上手。完成后，你将拥有一个可浏览的 Wiki，包含你运行过的所有 Claude Code 会话。
前置要求
- Python ≥ 3.9（macOS 默认自带 3.9+；大多数 Linux 发行版也是）
git- 已有若干 Claude Code 或 Codex CLI 会话保存在 Agent 默认的会话存储目录
就这些。无需 npm、无需 brew、无需数据库、无需账号。
安装
macOS / Linux
git clone https://github.com/AlexanderMakarov/llm-wiki.git
cd llm-wiki
./setup.sh
Windows
git clone https://github.com/AlexanderMakarov/llm-wiki.git
cd llm-wiki
setup.bat
setup.sh / setup.bat 会以幂等的方式完成以下步骤：
- 通过
pip install --user安装markdown（必需）。语法高亮使用 highlight.js（通过 CDN 加载）。 - 创建
raw/、wiki/、site/目录结构 - 运行
llmwiki adapters显示检测到的 Agent - 首次同步的 dry-run 预览，你可以看到将要转换哪些内容
安装后的两个命令
./sync.sh # 从 Agent 存储中拉取新会话 → raw/sessions/<project>/*.md
./build.sh # 将 raw/ + wiki/ 编译为 site/
在浏览器中打开 site/index.html — 站点就是普通文件，无需启动任何服务，也不会请求网络 — 然后试试：
- ⌘K 或 Ctrl+K — 命令面板
- / — 聚焦搜索栏
- g h / g p / g s — 跳转到首页 / 项目 / 会话
- j / k — 浏览会话表
- ? — 键盘快捷键帮助
下一步
- 架构 (Architecture) — Karpathy 三层 + 8 层构建拆解
- 配置 (Configuration) — 所有可调整的开关
- 隐私 (Privacy) — 默认脱敏 +
.llmwikiignore+ 仅本机绑定 - Claude Code 适配器
- Obsidian 适配器