SuperAPI AI 工具集

project-brain

写作与研究

查看项目

更新于 10-16 06:50

技能介绍

用途:在 Git 工作区中进行规划、回答、审查、诊断、文档编写或修改文件前,通过 gh 读取项目独立的 Git 知识库(Project Brain),把知识库当作证据来支撑工作。

主要能力:解析工作区根目录的 .project-brain.json 标记,确定知识库仓库与分支;用 gh 读取指定路径文件或克隆到临时目录进行检索;按 agent-guide.md、graphify-out/wiki/index.md、相关 wiki 页面、GRAPH_REPORT.md、context/ 人工材料、raw/ 机器记录的顺序阅读;引用知识库相对路径与提交短 SHA;区分已记录事实、合理推断与缺失信息;默认只读。

必要用法:先用 git rev-parse --show-toplevel 解析工作区根目录,检查 .project-brain.json;若存在则必须查阅知识库。标记格式为 {"repository": "owner/project-brain-repo", "defaultBranch": "main"}。运行 gh auth status,未认证则请用户执行 gh auth login 并停止。读取单文件:gh api --method GET "repos/OWNER/REPO/contents/PATH" -f "ref=BRANCH" -H "Accept: application/vnd.github.raw+json"。克隆检索:gh repo clone OWNER/REPO TEMP_DIR -- --depth 1 --branch BRANCH。用 gh api repos/OWNER/REPO/commits/BRANCH --jq '.sha' 解析提交。

适用场景:任何需要以项目知识库为依据的实质工作,尤其是跨仓库架构与决策上下文查询。

限制:知识库是独立仓库,不应克隆进当前工作区或作为子目录;无法访问时须报告具体阻塞,不得静默继续;不得打印令牌或认证信息;默认只读,不因代码与知识库不一致而修改知识库;用户明确要求更新知识时,不得推送默认分支,应克隆、建分支、只改相关人工文件并用 gh pr create 提交审查,且永不编辑 raw/ 机器内容。