@dayinxisheng/wikibrowser
v1.27.0
Published
代码越写越快，理解却越来越慢。你刚看完上一个模块，三个新功能又 push 上来了。
Readme
WikiBrowser
AI 一天写的代码，你要看一周
代码越写越快，理解却越来越慢。你刚看完上一个模块，三个新功能又 push 上来了。
WikiBrowser 把散落在各项目的 AI 生成文档聚合到一个窗口——全文搜索、划线笔记、划线提问。本地运行，私有仓库也能用。
为什么选 WikiBrowser
私有仓库，你的代码不离开你的机器。 DeepWiki、Zread 只能处理开源项目。你的内部项目？它们看不到。 WikiBrowser 本地运行，扫描你磁盘上的任何项目——私有仓库、内部工具、个人实验项目，全部支持。
| | 功能 | 说明 |
|---|---|---|
| 🔍 | 全文搜索 | jieba 中文分词 + BM25 排序，Ctrl+K 跨项目秒搜 |
| ✏️ | 划线笔记 | 选中文字点评论，插入 Callout 批注块，Markdown 原生保存 |
| 💬 | 划线提问 | 选中文字一键发送给 AI，带上文件路径和行号上下文 |
| 🤖 | 本地 AI | kimi-cli 接本地模型（Ollama / vLLM），数据不出机器 |
| 📊 | 富文档渲染 | Shiki 双主题代码高亮 + Mermaid 交互式图表 |
30 秒上手
环境要求
- Node.js >= 18 <= 22（推荐 20 LTS）
- npm >= 9
注意：由于依赖
better-sqlite3（原生 C++ 模块），目前不支持 Node.js 23+。推荐使用 Node.js 20 LTS 以获得最佳兼容性。
安装启动
npm install -g @dayinxisheng/wikibrowser
wikibrowser start浏览器打开 http://127.0.0.1:9001，完事。
需要先生成 Wiki 文档？在任何项目中用 Claude Code / Kimi CLI 输入
生成 wiki即可，详见 Wiki 生成指南。
CLI 命令
wikibrowser start [--host] [--port] [...] # 后台启动服务
wikibrowser stop # 停止服务
wikibrowser restart # 重启服务
wikibrowser status # 查看运行状态
wikibrowser logs # 实时查看日志（Ctrl+C 退出）
wikibrowser config set <key> <value> # 设置配置项
wikibrowser config list # 查看所有配置
wikibrowser skill:install [name] # 安装内置 skill（默认全部）
wikibrowser skill:list # 列出 skills 及安装状态
wikibrowser skill:uninstall <name> # 卸载 skill配置管理
配置文件位于 ~/.wikibrowser/config.json，通过 config 子命令管理：
wikibrowser config set port 8080 # 修改端口
wikibrowser config set host 0.0.0.0 # 局域网访问
wikibrowser config set authCode '...' # 自定义密码
wikibrowser config list # 查看所有配置
wikibrowser config reset # 恢复默认值认证说明
| 场景 | 行为 |
|------|------|
| 本地访问（127.0.0.1） | 默认无需密码 |
| 局域网访问（0.0.0.0） | 自动生成 18 位密码，保存在配置文件中 |
| 自定义密码 | config set authCode <密码> 设置（18位，需含大小写/数字/特殊字符） |
| 关闭认证 | start --no-auth（仅允许本地绑定） |
划线就能用
笔记 — 选中 → 评论 → Callout 块
阅读文档时选中任意文字，浮动工具栏弹出。点「评论」，自动在选区下方插入一个 Callout 批注块，支持 NOTE / TIP / WARNING / CAUTION / IMPORTANT 五种类型。批注直接写入 Markdown 源文件，Obsidian 兼容。
提问 — 选中 → 发给 AI → 带上下文的回答
同一个浮动工具栏，点「发送给 AI」，选中的文字会带着文件路径和行号作为上下文引用，在 AI 面板中生成回答。接本地模型（Ollama / vLLM），代码不离开你的机器。
架构概览
使用指南
| 指南 | 说明 | |------|------| | 快速上手 | 项目扫描、界面概览、基本操作流程 | | Wiki 生成 | 用 AI Skill 为你的项目生成 Wiki 文档 | | AI 对话 | AI 辅助对话、划线提问、工具审批 | | 搜索与笔记 | 全文搜索、划线笔记、快捷键 |
技术栈
TypeScript · React · Express · SQLite · Shiki · Mermaid · Zustand · Vite
开发
npm install # 安装依赖
npm run dev # 开发模式（前后端同时启动）
npm test # 运行测试
npm run build # 构建生产版本
npm run build:e2e && npm run test:e2e # E2E 测试