gitlink-kb

一个仓库知识库问答的 GitLink AI Agent Skill。索引 README、docs 目录与各类 Markdown 文档，支持关键词检索、文档地图生成、FAQ 提取，让仓库沉淀的知识可被快速查询——无需克隆仓库。

GitLink 智能化服务开源项目贡献赛 子赛题二（编写和丰富 GitLink Skills） 参赛作品。

作者：Ct201314

它解决什么

一个项目的文档往往散落在 README、docs 目录、Wiki 里。想找”怎么安装””如何配置”的答案，常常要翻好几个文件。gitlink-kb 把仓库文档变成可问答的知识库：

• 关键词检索：在所有文档段落中找出与问题最相关的内容（中英文都支持）
• 文档地图：一眼看清仓库有哪些文档、每个文档讲了什么
• FAQ 提取：自动识别文档里形似问题的标题，整理成问答对

全部基于规则、可解释，不依赖大模型。

安装

作为 Agent Skill

把 SKILL.md 与 scripts/ 放入 Agent 技能目录（Claude Code、Cursor、Kiro CLI 等），向 Agent 提出诉求即可触发，例如：

「Gitlink/gitlink-cli 怎么安装？从它的文档里找答案」

直接运行脚本

# 检索
python scripts/kb.py --owner Gitlink --repo gitlink-cli --query "如何安装"

# 文档地图
python scripts/kb.py --owner Gitlink --repo gitlink-cli --map

# FAQ 提取
python scripts/kb.py --owner Gitlink --repo gitlink-cli --faq

目录结构

gitlink-kb/
├── SKILL.md
├── scripts/
│   ├── glapi.py          GitLink 公开 API 客户端（自包含）
│   └── kb.py             文档索引与检索脚本
├── examples/             真实检索结果 + FAQ
├── tests/test_kb.py      单元测试（14 个用例）
├── requirements.txt
└── LICENSE

真实验证

在 Gitlink/gitlink-cli 上运行：

• 检索”如何安装”→ 精准命中 README 的安装段落（含中文 README.zh-CN.md）
• FAQ 提取 → 识别出”Why gitlink-cli?”、”npm 安装成功但缺少二进制怎么办”等问答

产物见 examples/。

单元测试：

python -m pytest tests/ -q   # 14 passed

设计要点

• 中英文检索：英文按词切分，中文做 2-gram 切分，对中英混排文档都有效。
• 标题加权：命中标题的段落优先返回，更贴近用户意图。
• 多文档来源：README + docs/doc/.gitlink/wiki 目录统一索引。

许可证

Mulan PSL v2，与 gitlink-cli 主仓库保持一致。