知识库与 RAG工具
wikify-repo:把任意代码库编译为可供 AI Agent 检索的可信 Markdown 知识库 Wiki
vlasenkoalexey/wikify-repo · Compile any codebase into a grounded, lint-clean markdown wiki your AI agent can actually trust — SCIP symbol resolution + citation linter, plain markdown you own (no graph DB, no SaaS).
ELI5:它是什么,解决什么问题
wikify-repo 通过 SCIP 符号解析把代码库编译成基于真实符号引用的 Markdown Wiki,并用引用 linter 在构建时强制每条论断都能解析到已固定的源码符号;输出为可离线 grep 检索的纯 Markdown,无需图数据库、向量库或托管服务,支持增量重建和跨仓库概念页。
核心能力与快速开始
★ 1 · Python
- 能做什么
- 将代码库编译为带引用的 Markdown Wiki:用 SCIP(scip-python / scip-clang 等索引器)做编译器级符号解析,为每个符号生成索引行(锚点、路径、行号、类型、rank、body hash、调用方、引用页面)及完整调用边列表与模块图;为每个子系统生成机制页、架构图与 Mermaid 机制图(节点映射到目录符号并在构建期校验);生成顶层区域页与总览页;引用 linter 作为硬性构建门禁,无法解析到真实符号的论断会使构建失败;对抗式验证尝试用源码反驳每条关键论断;支持增量重建(固定 commit 后按符号粒度重建、迁移符号重新链接、仅重新验证证据变化的论断),并记录 changes/<ref>.md;支持跨仓库概念页;输出带 OKF v0.2 front matter(generated、verified、sources)的纯 Markdown,检索仅需 grep 与 index.md。
- 适用场景
- 适用于代码规模超出阅读能力、需要让编码 Agent(Claude Code、Codex、Antigravity)从可信知识库回答代码内部问题的团队;跨多个仓库共享同一概念的知识库;无需导览的代码库上手;希望以 grep 方式离线检索、且把 Wiki 作为纯 Markdown 纳入自有 git 仓库管理的场景。
- 项目形态
- 可直接使用的工具
- 部署方式
- 本地运行,提供 CLI(pipx 或 pip 安装),生成的 Wiki 为本地纯 Markdown 文件,无图数据库、仪表盘或托管服务;未说明其他部署方式。
- 主要依赖
- Python ≥ 3.11 与 git;索引 Python 或 TS/JS 需要 Node.js + npm,C++ 索引器为下载的二进制;SCIP 索引器(scip-python、scip-clang、TS/JS、Go、Rust)在首次需要时按需安装到 ~/.wikify/vendor;Windows 原生环境需 PYTHONUTF8=1,scip-python 需 PATH 上有 pip,且 @sourcegraph/scip-python 0.6.x 在 Windows 上需修补。
- 使用限制
- SCIP 索引器比零构建 AST 解析更重(需要真实索引器,C++ 需要 compile_commands.json);不擅长任意传递查询,常见传递问题以预先生成的纯文本索引与调用边列表替代;未说明 API 成本、硬件要求及是否可商用(仅标 MIT 许可)。
- 许可证
- MIT
- 最近推送
- 2026-10-03 08:56
资料检查:2026-10-04 07:00 · 卡片整理:2026-10-04 07:00
卡片由 AI 根据仓库资料整理,未进行安装或运行验证 · 本次更新未完成,保留上次成功内容
职业应用
程序员
将代码库编译为基于真实符号引用的 Markdown Wiki,供 AI Agent 检索;用于代码理解、技术文档生成、代码审查与排错时让 Agent 从可信知识库中检索代码内部结构。
查看内容依据
Compile any codebase into a grounded, lint-clean markdown wiki your AI agent can actually trust — SCIP symbol resolution + citation linter, plain markdown you own (no graph DB, no SaaS).
由 AI 根据来源材料整理,未进行安装或运行验证
讨论 0
登录后参与讨论,阅读资讯无需注册。
还没有评论,来分享第一个看法。