repo-agent-brief

自动提取代码库关键信息,生成安全导向的简要说明文档。

已扫描
适合谁
前端/后端开发工程师、技术负责人与团队管理者
不适合谁
无代码仓库操作经验的初学者、无需代码协作的非技术人员
国内可用性
需网络配置。可能需要网络配置或第三方服务可访问。
安装难度
新手友好(★☆☆)。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @builtbyecho/repo-agent-brief

Skill 说明

命令、参数、文件名以原文为准

仓库代理简报技能

使用 @builtbyecho/repo-agent-brief 在代理编辑或审查仓库之前进行上下文定位。它会查找高价值的上下文文件,推断技术栈与命令,生成简洁的仓库地图,并标记明显的密钥或高风险指令模式。

默认工作流程

从仓库根目录开始:

npx @builtbyecho/repo-agent-brief . > AGENT_BRIEF.md
sed -n '1,220p' AGENT_BRIEF.md

针对正在进行中的分支:

npx @builtbyecho/repo-agent-brief . --diff origin/main > AGENT_HANDOFF.md
sed -n '1,260p' AGENT_HANDOFF.md

用于机器可读的自动化场景:

npx @builtbyecho/repo-agent-brief . --format json > agent-brief.json

用于持久化交接:

npx @builtbyecho/repo-agent-brief . --diff HEAD --bundle
sed -n '1,220p' .agent-brief/brief.md
sed -n '1,160p' .agent-brief/verification.md

使用场景

  • 首次接触不熟悉的仓库时。
  • 在将任务委派给编码代理前。
  • PR/分支交接时,尤其关注变更文件内容。
  • 在修改 CI 配置、迁移脚本、部署脚本、认证逻辑或配置文件前进行安全预检。

安全注意事项

  • 此工具并非完整的密钥扫描器。如需全面审计,请使用 Gitleaks 或 TruffleHog。
  • 若发现高风险模式,请在继续操作前手动检查。
  • 在 CI 环境或严格代理工作流中,可使用 --fail-on-high-risk 参数强制中断。
  • 生成的简报可能包含来自仓库上下文文件的代码片段;请勿未经审查直接公开。

常用命令

npx @builtbyecho/repo-agent-brief .
npx @builtbyecho/repo-agent-brief . --diff HEAD
npx @builtbyecho/repo-agent-brief . --diff HEAD --bundle
npx @builtbyecho/repo-agent-brief . --diff origin/main --fail-on-high-risk
npx @builtbyecho/repo-agent-brief . --no-snippets
B
@builtbyecho

已收录 1 个 Skill

相关推荐