项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-10-26 · 当前星标 ★ 1544
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- curl 与 bash(安装脚本通过 curl | bash 方式执行)
- 已安装并可使用 Codex、Cursor、Copilot 等受支持的编码代理
- 项目根目录可写入(用于放置 .brooks-lint.yaml 配置文件)
安装与启动步骤
-
1确认运行环境
先确认本机有 curl 和 bash,并已在使用 Codex、Cursor、Copilot 等受支持的编码代理;技能包以文件形式安装到代理配置中。
-
2运行安装脚本
README 给出的安装命令,
需替换为你的代理平台名(README 未列出可选值,请对照安装脚本或官网确认);默认装到全局配置。 curl -fsSL https://raw.githubusercontent.com/hyhmrright/brooks-lint/main/scripts/install.sh | bash -s -- -
3创建项目配置
可选:在项目根目录放置 .brooks-lint.yaml 来自定义审查行为,如严格度、禁用某类检查、调整严重级别与忽略路径。
-
4在代理中触发审查
安装完成后,在编码代理中调用 /brooks-review 命令对代码做评审,输出健康分与分级问题清单。
/brooks-review
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
version | 是 | 配置文件版本号,README 示例为 1。 | 1 |
strictness | 否 | 评分严格度:strict / balanced(默认)/ legacy-friendly。 | balanced |
disable | 否 | 按编号禁用某类检查,如 T5 表示跳过覆盖率指标检查。 | [T5] |
severity | 否 | 按领域下调或调整某类发现的严重级别。 | R1: suggestion |
ignore | 否 | 以通配符列出不参与审查的文件或目录。 | ["**/*.generated.*", "**/vendor/**"] |
如何确认成功
在编码代理中执行 /brooks-review,能看到健康分(如 28/100)以及按 Symptom→Source→Consequence→Remedy 列出的问题,说明技能已生效。
常见问题
Q:安装命令里的
A:README 只说明“选择你的平台”,并未列出具体取值;请对照安装脚本或官网说明填写对应编码代理的平台名。若填写错误,安装脚本可能无法把技能放到正确位置。
Q:只想给当前仓库安装,不动全局配置怎么办?
A:README 提示 --project 参数会把技能装进当前仓库而不是全局配置;在安装命令后追加该参数即可。
Q:老项目评分太低、误报多怎么办?
A:把配置文件中的 strictness 改为 legacy-friendly,可对遗留代码使用更宽松的评分;也可用 severity 下调个别领域的级别。
Q:不想强制统计测试覆盖率?
A:在配置文件的 disable 列表中加入 T5,即可跳过覆盖率指标检查。
注意事项
- 本文所有命令与配置项均取自 README,README 未给出的平台参数取值、端口、路径不予臆造。
- 配置文件 .brooks-lint.yaml 需放在项目根目录才会生效。
- 技能包以 Agent Skills 文件形式分发,不绑定特定 IDE 或模型,换代理可复用同一套评审标准。
核心亮点
- 以 Agent Skills 形式分发,不绑定具体 IDE 或模型,Codex、Cursor、Copilot 之间可复用同一套评审标准
- 六个技能分工明确,覆盖架构、技术债务、测试与修复建议,形成从发现问题到给出方案的闭环
- 把 Clean Architecture 等工程原则固化为可执行检查项,降低团队对资深评审者的依赖
不足之处
- 以 HTML 为主要语言、技能文件为主,缺少可独立运行的程序化校验,效果高度依赖所接入代理的理解能力
- 评审结论的稳定性和误报率缺少公开的量化评测数据,团队落地前需自行验证
- 文档与社区规模仍处早期,复杂项目的定制化扩展指引有限
适用场景
- 团队用 Cursor 或 Copilot 批量生成业务代码后,在提交前跑一轮架构与技术债务检查
- 接手遗留项目时,让编码代理按技能清单快速梳理模块耦合与腐化点
- 在 CI 前的本地开发环节,把测试充分性评估纳入 AI 编码的日常流程
替代项目
claude-code、aider、continue
上一篇:REA-Prompts
下一篇:codex
同类项目推荐
loopy
开源
写一遍数组循环,自动生成 CPU/GPU 高效代码
A code generator for array-based code on CPUs and GPUs
CodeInsight
开源
用中文问代码库,带出处回答,快速看懂陌生项目
基于 Hybrid RAG 与 LangGraph 的本地代码仓库理解工具,支持中英文提问、语义检索、证据引···
nvim
开源
NeoVim 写 LaTeX,边写边让 AI 帮你改
NeoVim configuration optimized for writing in LaTeX with AI integration for Avante, ···
ops-codegraph-tool
开源
本地运行,让 AI 代理秒懂 34 种语言的代码依赖与风险。
Code intelligence CLI — function-level dependency graph across 34 languages, 34-too···
shellcheck
开源
写 shell 脚本前跑一下,自动揪出坑和隐患
ShellCheck, a static analysis tool for shell scripts
opencode-mobile
开源
手机变编码副驾,远程操控 AI 代理,实时看代码生成。
Native iOS app for OpenCode AI coding agent — built with Expo & React Native. Real-···
specweave
开源
说需求,AI 出规格、拆任务、写代码并同步到 JIRA
Spec-first AI development: describe a feature → AI creates spec + plan + tasks, bui···
llm.nvim
开源
在 Neovim 里直接调 LLM 写代码、改代码、问代码
LLM powered development for Neovim
flemma.nvim
开源
在 Neovim 里直接调用多模型 AI,边写代码边问,不切窗口
AI knowledge workbench for Neovim.
