格鲁姆
在设计合同上保留一个存储器 你的团队在 格鲁姆。 。 。 .
Grum 读取寄存器声明的符号( CSS 自定义属性, a Tailwind v4) @theme,SCSS变量),以及它定义的按钮和文本输入设计. 球队可以在代码得到之前在格鲁姆添加指使符,并将其他人移出合同. 那一套审查是 grum 检查。 它比较你的工作树与合同,只列出这个分支上的新漂移,并且可以发送一个新项目给项目的所有者审查,并附上它如何制作的图片.
要求节点.js 22或更新.
快开始
在寄存器中打开终端, 运行时没有参数 :
npx @grum-os/cli
格鲁姆打开了巫师。 箭头键会移动, Enter selections, 直接跳到一行 1 到 4 . q 退出菜单。 你选一排后, c 取消该命令并返回菜单.
1 Check Check your changes against the design contract
2 Recommendations Pick and run the latest scan's recommendations
3 Setup Sign in, link this repository, set up Cursor
4 Login Sign in to Grum
选择 设置格鲁姆走过剩下的:
- 签字. 它会打印代码和链接. 批准浏览器中的代码 。 信使会留在您的家目录中( R)
~/.config/grum/credentials/),从未入库. Grum 的设置页面列出每个签名的计算机. - 链接此寄存器 在格鲁姆的项目。 如果几个工作区使用它,你就选一个。 如果还没有,格鲁姆提议创建一个工作空间,要求现场,并在第一次扫描运行时等待. 一个新的工作空间需要 GitHub 在 Grum 连接.
- 设通克. 它问
Setup for cursor agents?按 Enter 键接受 。 这写了钩子,工具, 和下文描述的规则.n跳过它。 然后它问Add a pre-commit check?输入跳过.y添加grum check --staged到此寄存器已经使用的钩子 .
那就选择 检查. 新的漂移以一行固定方式列出,而格鲁姆提出将每个项目送去审查. 您不需要输入命令 .
一旦你签约,最后一行是 注销运行 grum 重新选择 设置 以更改链接或关闭光标。 输入保留每个当前设置 .
重新扫描工作空间
更改代码后运行 grum scan 在链接寄存器中启动新的服务器侧扫描,并跟踪其在终端的进展。 添加 --root <dir> 当工作空间是单列波内部的文件夹时。 扫描以格鲁姆语进行,可能需要几分钟时间. Ctrl+C停止等待,但扫描持续运行. 只有工作空间所有者才能开始扫描. 扫描完成后,格鲁姆列出其 建议。 。 。 .
建议
在设置后和每次扫描后,格鲁姆会列出一些建议:可以快速完成的,有即时值的,例如缺少设计指南或者已经匹配一个符号的手型值. 他们和格鲁姆的推荐名单一样 不包括你所在的团队.
选择 建议 在菜单中(或运行) grum wins)来选择要做什么,然后发送到哪里: Claude Code 或 Codex 从那里开始, Cursor 在聊天框中打开,或者复制或打印它。 几个选择作为一个快速,一次完成一个。 当人们持有一个草稿(例如,何时使用每个按钮样式)时,代理人会先向您显示以更正.
grum wins # pick and send them
grum wins 2 # print the prompt for the second one
在克洛德代码和光标中,类型 /quick-wins,或者只是要求"建议"。 Codex没有项目命令,所以要求它"建议". 代理显示列表并询问要做什么.
和你的经纪人搭配
一个编码代理可以进行这种设置. 你粘贴一个提示进入聊天,并在浏览器中批准一个代码. 您不需要打开终端 .
你打开的页面是 www.grum.so/设置。该提示提示代理人 app.grum.so/代理软件,这是标记下的指示。 代理运行 :
npx --yes --prefer-online @grum-os/cli@latest setup --agent cursor --json
使用 codex, (中文(简体) ), claude (Claude代码)或 generic 改为 cursor 为了那些特工 命令印出JSON的指纹. 0出站表示准备就绪,2出站表示代理商应当采取下一项动作并再次运行,1出站表示失误. grum doctor --agent cursor --json 报告相同的检查和改变什么.
重运行设置在保存自己的钩和设置的同时刷新已有的集成文件. 代理完成验证 grum_doctor 通过MCP,这证实了该聊天中的关联. 如果 shell 检查无法验证工具, 它会要求代理在发送到设置前发现并调用工具 。 当它的MCP连接被确认,并成功运行了钩子后, Codex就绪了. 已更改的钩子命令需要在 Codex 中审查;使用相同命令的新格鲁姆发布会保持他们现有的信任.
Grum 生成 .grum/AGENTS.md 本地设置时, 忽略其余部分 .grum/中的短块 AGENTS.md 财务报告和审定财务报表 CLAUDE.md,以及光标规则,当您在场时读取此文件 。 一个新克隆通过设置提示生成;一个缺失的文件不会触发自动设置. 正常的CLI使用,成功的MCP合同/检查呼叫并停止维护刷新安装的集成. 本地生成的指南可在不跟踪的情况下更新。 仓库指令文件仍然需要一个干净的履带基线,而格鲁姆从不分级更改.
代理设置 问您的应用程序在本地运行。 仓库 URL 和 index.html 是建议;在选择前,代理人必须先询问。 旧的保存地址确认一次 。 本地的 HTTP 页面必须返回 200; 重定向, 404, 访问拒绝, 连接拒绝和超时保持设置不全 。 在成功探测后,代理在其可见浏览器(Codex使用其浏览器面板)中打开页面,检查渲染,并报告任何问题. 设置返回 preview-local-app 直到代理机以 localPreviewed 内 grum_setup,或 --local-previewed <url> 在CLI中。 如果浏览器控制不可用, 代理服务器会要求您打开 URL 并确认它 。 新地址需要新的预览 。 明确选择的静态 HTML 文件也需要预览;文件的存在并不能证明渲染. 选择 none 如果您想要跳过本地应用程序 .
代理也可以在可见浏览器中打开一页,当他们要你看到他们指的一页或问你的一页. Grum设置操作仍然使用CLI;当浏览器控制可用时,代理机会自己打开页面.
菜单和上面的命令保持不变. --agent 是一种额外的进入方式,而不是替代.
光标
接受菜单中的光标将格鲁姆放入代理. 代理人遵循某人在格鲁姆看到的同一合同,可以要求业主允许合同没有的东西.
在它写UI之前,它读取合同:颜色、打字、间距和半径符号,加上按钮组件和外观、核准的文本输入、复选框、收音机、开关、选择、动作菜单和分页以及使用规则.
还没完呢它检查它改变了什么。 已漂移在默认分行的列表中 。 新的漂流带固定器回来.
当合同里没有合适的它停下来问你一次:
- 使用已有的符号或按钮 .
- 保留新风格并请求审查.
如果你保留它,格鲁姆会捕捉元素是如何制作的并发送图片到评论页面. 屋主在那里批准或拒绝。 拒绝的样式不再提供:代理更改代码以使用合同.
编辑时,代理机读取本地合同缓存,编辑勾钩时只读取已更改的文件. 格鲁姆不要求他们获取合同,刷新整合或检查编辑之间的漂移. 转弯时,停止钩检查他们的改变 并报告一次新的阻断漂移, 然后等待你的选择。 明确的格鲁姆请求仍然使用这些工具. 与 封锁 打开了,单独的外壳守卫拒绝 git commit 财务报告和审定财务报表 git push 挡住漂流.
格鲁姆还保持了在转弯端的运行时间. 更新背景运行的下载,保留工作版下线,并保留已安装的钩子命令不变. 运行MCP桥 调换工人之间的通话。 更改的计时指令在已存在的工具钩上一次作为紧凑上下文到达被支持的代理. 维护从不创建聊天信息或强迫另一回转. GRUM AUTO UPDATE=off 禁用运行时间下载并激活.
设置后重新装入光标窗口, 或打开 格鲁姆 在设置、工具和 MCP 下,代理查看工具。 之前,它读 .grum/contract.json。 。 。 .
这些是文件的设置 它们合并到已经存在的东西中,第二次运行不会改变任何东西.
| 文件 | 它会做什么 |
|---|---|
.cursor/mcp.json | 代理调用的工具 : grum_contract, (中文(简体) ), grum_check, (中文(简体) ), grum_request_review, (中文(简体) ), grum_add_to_contract, (中文(简体) ), grum_snooze_review, (中文(简体) ), grum_review_status, (中文(简体) ), grum_setup,以及 grum_doctor。 。 。 . |
.cursor/rules/grum.mdc | 一个短指针,指示代理人读取 .grum/AGENTS.md格鲁姆的指示 这些是当地产生的,被Git忽略了,所以对它们的更新永远不是要承诺的改变. |
.cursor/hooks.json | 跟踪已编辑的文件 。 停止钩报告 新的阻断漂移在转弯端。 壳钩可以拒绝 git commit 财务报告和审定财务报表 git push。 。 。 . |
| 承诺前 | 可选的 当你答应,加 grum check --staged. . 胡斯基的钩子 与回波。 Git自己的承诺前钩子留在这台电脑上. 左侧的回放让片段被粘上. |
.grum/ 添加到 .gitignore 第一次格鲁姆写到那里。 选择 设置 再来一次,回答 n 以删除 Grum 添加的内容。 答复 n 到承诺前的问题,只放弃支票.
grum check --cursor 打开在 Cursor 的发现,而不是在终端中走过它们.
代码
grum init codex (或 grum setup,当存储器有一个 .codex 文件夹)将同一份合同放入Codex: CLI,桌面应用程序和IDE扩展名中,在这个计算机上. 代理在写UI前阅读合同,在合同完成前进行核对,并在合同无一符合时问你一次,恰好是Cursor的.
Codex将项目配置和钩子置于您控制之下. 格鲁姆不会出现在MCP 或 Hooks 中,直到你做这两个:
- 当 Codex 询问时信任此文件夹 。 然后进入 设置 > MCP 服务器打开 格鲁姆。如果 Codex 用此文件夹的名称标签服务器,请选择命令运行的服务器
grum.mjs。 。 。 . - 打开 设置 > 钩子 检查 Grum 的 3 个命令( 他们说“ 需要审查 ” 并运行)
grum.mjs hook ...) (中文(简体) ). 打开任何已关闭的;这与MCP分开。 在终端应用程序中,运行/hooks以审查名单.
没有步骤2 工具仍然工作 代理仍然遵循指导, 但没有任何检查 当Codex停止和 git commit 财务报告和审定财务报表 git push 不被拒绝。 在格鲁姆观察成功钩跑之前,它报告说钩跑状态是未经证实的.
| 文件 | 它会做什么 |
|---|---|
.codex/config.toml | 添加同样的八种工具. 只有格鲁姆自己的块被写入;剩下的文件被保留在原地,一个无效的TOML停止设置的文件. |
.codex/hooks.json | 3个钩子,除了你的任何: 编辑之后, 贝壳命令之前,和停止。 他们的行为就像Cursor的,包括 封锁。 。 。 . |
AGENTS.md | 一个短的标记块,让代理读取 .grum/AGENTS.md。 。 。 . |
.grum/AGENTS.md | 格鲁姆的代理指示:阅读合同,在合同停止前检查,在保留合同外的风格之前询问. 由本地生成并被Git忽略;Grum自动维护. |
grum init codex --remove 把这些完全拿出来。 为一个以上代理人设置的仓库保存 .gitignore 线条和承诺前检查,直到删除最后一个.
克劳德代码
grum init claude (或 grum setup,当存储器有一个 .claude 文件夹)将同一合同放入Claude Code: CLI,桌面应用程序和IDE扩展,在此计算机上. 代理在写UI前阅读合同,在合同完成前进行核对,并在合同无一符合时问你一次,恰好是Cursor的.
Claude Code只在您信任的文件夹中运行一个工程的工具和钩子,所以一步是您的:在寄存器中启动一个新的Claude Code会话,并在寄存器询问时信任文件夹. 如果它问起 格鲁姆 MCP服务器,批准. 已经打开的会话保留了它的旧钩子和工具,直到开始新的会话.
| 文件 | 它会做什么 |
|---|---|
.mcp.json | 添加同样的八种工具. 文件内的其他服务器则保留原样. |
.claude/settings.json | 3个钩子,除了你的任何: 编辑之后, 贝壳命令之前,和停止。 他们的行为就像Cursor的,包括 封锁2. 还核准 格鲁姆 服务器. |
CLAUDE.md | 一个读取本地标记的短块 .grum/AGENTS.md 此时此刻 设置提示以新的克隆生成文件 . |
.grum/AGENTS.md | 格鲁姆的代理指令,与Codex共享. 由本地生成并被Git忽略;Grum自动维护. |
grum init claude --remove 准确取出这些; 其余的每个文件都留下 .
什么支票显示
选择 检查 在菜单中打印出与 grum check。 。 。 .
新漂移按文件分组 。 每行都标出价值,漂移的种类,是否有人要求审查,以及固定:
src/pages/Hero.tsx
18: Hard-coded #3C3C3C should be merged into the --text-primary token [Hard-coded value, Not sent for review]
fix: Use --text-primary (#1B1B1B) instead of #3C3C3C.
1 new drift item against Acme's contract: 1 not sent for review (42 files checked).
漂移默认分支上已有的最新扫描被计数, 不列出 。 漂流的人也在漂流的一页里被开除了 一个只重复这些看起来干净的分支:
No new drift against Acme's contract (42 files checked). 3 known issues are on Acme's Drift page.
在比默认分行多的地方使用已知值是新漂移.
在终端,支票之后提供每个新项目以供审查。 一个请求覆盖了它被问到的分支,直到更改到达默认分支并扫描算出漂移是存在的. 完整的检查也标志着审查被拒绝 已处理 当漂流消失时,当漂流回来时,它重新开放.
检查打印了报表并退出 0, 包括您被签名退出时, 离线, 或寄存器从未扫描过 。 它只有在你要求的时候才会失败.
它要找的东西
| 区域 | 新漂移 |
|---|---|
| 颜色 | 硬编码的颜色、与合同颜色几乎相同的颜色或合同没有的颜色标志 |
| 类型 | 合同标尺以外的大小、重量或行高 |
| 间距 | 标尺外的比值、 垫入或间隙 |
| 半径 | 半径 |
| 按钮 | 看合同没有,看谁的状态变了 一个缺失的状态,一个原始的 <button> 按钮组件外, 或组件缺少的变体 |
| 投入 | 文本输入与核准的输入不符,或与结构、外观或状态不同 |
| 复选框 | 一个复选框,可以覆盖一个核准的复选框(它的框,标记,标签,或者一个检查,不确定,禁用,或者焦点状态),或者一个其核准的状态已经消失的复选框 |
| 无线电 | 超过核定收音机的收音机(其选项、标记、标签、或检查、禁用或焦点状态),或其核定状态已消失的收音机。 一组收音机的设置方式没有检查过 |
| 开关 | 超过批准开关的开关(其轨迹、拇指、标签、拇指行走,或检查、禁用或焦点状态),或批准状态已消失的开关。 未检查开关周围的设置行 |
有件事情要自己审查
菜单的支票已经提供了这个。 要直接发送一个查找,请使用其密钥(grum check --json 打印出来:
grum request "color:raw:#3C3C3C" \
--reason "The marketing hero uses this gray" \
--url http://localhost:3000
本地应用程序默认抓取 。 使用 grum request <key> [<key>...] --live 在发布后抓取已配置的现场站点。 Grum在可以时使用由查找源文件确定的路由,否则该站点的配置了URL. 这使得保存的本地应用程序 URL 不变, 并且没有添加确认提示 。 目标 URL 在抓取前会打印出.
--url 是元素生成的一页,或者Repo中的 HTML 文件(./index.html当没有dev服务器时。 明确 --url 拥有优先级 --live,包括当共享组件需要特定页面时。 在您自己的浏览器会话中通过浏览器扩展获取登录后的一个页面. --browser chrome 或者说 --browser safari 选择浏览器. --no-capture 发送请求时没有图片 。 对于一个模式的发现, --open-modal-id <id> 财务报告和审定财务报表 --open-trigger-id <id> 明确指明所要求的模式及其打开器。 现有 扫描供审查 动作打开所需的模式,然后抓取它。 如果模式已经可见,则不点击打开器即可捕捉. 它只点击一个唯一,可见,启用的带有该id的按钮,然后在所请求的模式被观察打开后才抓取. 提交控件,缺少或复制ID,没有打开支持的客户端被拒绝;手动打开和扫描重试仍然可用.
grum capture reset
清除保存到此寄存器的抓取浏览器签名 .
阅读合同
grum contract
应要求获取并打印合同包:按类别划分的符号(如果有则有单独的暗值),按钮组件和外观,核准的文本输入,复选框,收音机,开关,选择,动作菜单和分页,团队指南,快取,以及审查决定. 普通代理编辑读取本地缓存而不是运行此命令 .
检查失败
报告是默认的,所以缺失的签入不能违反承诺. 当漂移从未被送去审查或被拒绝时失败:
grum check --ci
--strict 还在等待审查时失败。 有待审查的通行证 --ci。 。 。 .
同样的规则可以生活 .grum/config.json数字 :
{
"root": "apps/web",
"block": true,
"denyGit": ["commit", "push"],
"maxFollowups": 2
}
| 外地 | 含义 |
|---|---|
root | 当应用程序不在寄存器根时扫描目录 . grum check --root 一次跑步也一样. |
block | true 制造 grum check 在打开或拒绝漂移时失败, 让克索尔, Codex 和克洛德代码拒绝下面的 git 命令, 而漂移在他们发送的. |
denyGit | commit, (中文(简体) ), push或两者兼有。 与 block 没有 denyGit两者都被拒绝. |
maxFollowups | Cursor, Codex或Claude代码停止钩子多少次将代理机送回一次对话. 默认为 2. |
block 正在等待审查的检查不会失败。 使用 --strict 对于这个.
格鲁姆加 /.grum/ 改为 .gitignore,所以生成了指令 和所有其他的 本地状态留在这台计算机。 设置和自动集成刷新取代了格鲁姆之前的共享指令例外. 如果之前已经执行指令,请运行 git rm --cached -- .grum/AGENTS.md 一次并用忽略规则更改来承诺删除。 本地文件保留在磁盘上; Grum 从未改变索引本身 。 有意共享配置, 使用 .grum/* 财务报告和审定财务报表 !.grum/config.json,将生成指令忽略.
持续融合
从菜单上签名一次,然后复制 token 字段来自此 Grum 的证书文件。 对于 app.grum.so (英语) 文件为:
~/.config/grum/credentials/https_app_grum_so.json
把它藏为秘密 别犯法 在你所属的每一个工作区, 象征都像你一样 Grum 中的设置列出了这些登录, 并可以取消一个 .
# GitHub Actions
- name: Check the design contract
run: npx --yes --prefer-online @grum-os/cli@latest check --ci
env:
GRUM_TOKEN: ${{ secrets.GRUM_TOKEN }}
GRUM_TOKEN 改为使用机器上保存的符号.
图标
菜单包括检查、设置和登录。 这些都是与旗帜相同的行动, 对于脚本和CI.
| 命令 | 它会做什么 |
|---|---|
grum | 菜单 检查,设置(包括光标),或签入. |
grum login 编号 : grum logout | 把这台电脑签到格鲁姆,或退出. |
grum setup [--root <dir>] | 签名, 链接此寄存器, 并询问 Cursor 和预承诺检查 。 使用 --agent <agent> --json 代理设置. |
grum doctor [--agent <agent> --json] | 检查设置准备,不改变任何东西. |
grum scan [--root <dir>] | 对链接的工作空间启动新扫描并跟踪其进展 . |
grum check [flags] | 检查工作树。 见下所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出所出. |
| `----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------)--------------------------------------------- | [-开放-模式-id-open-trigger-id-d] [-不捕取]' |
grum add-token ... 编号 : grum add-button ... | 对于所有者,在合同中增加一个符号或经批准的按钮设计. |
grum add-icon <ref> [--name <name>] | 对于所有者,请添加图标 grum check --json 清单 discovered.icons,从这个退出的来源. |
grum snooze <key> [<key>...] | 暂停关于此分支已存在的漂移问题 . |
grum uninstall [--yes] | 从此寄存器和此计算机中删除 Grum 。 见 卸载。 。 。 . |
grum capture reset | 清除此寄存器保存了抓取浏览器的登录. |
grum contract | 打印合同包. |
grum wins [<number>] | 选个推荐书寄给你的经纪人 或者立即打印出来 见 建议。 。 。 . |
grum feedback "<what happened>" [--kind <kind>] | 告诉格鲁姆团队一个问题,混乱或问题. <kind> 实值 question, (中文(简体) ), confused, (中文(简体) ), problem 或者说 idea。如果格鲁姆无法到达,它会等待和与下一个发送. |
grum init cursor [--remove] [--force] [--local-only] [--pre-commit] | 写入或删除没有菜单的光标文件 . --pre-commit 加上承诺检查. --no-pre-commit 将取去. |
grum init codex [--remove] [--force] [--local-only] [--pre-commit] | Codex 也一样 : .codex/config.toml, (中文(简体) ), .codex/hooks.json,则 AGENTS.md 块和 .grum/AGENTS.md。 。 。 . |
grum init claude [--remove] [--force] [--local-only] [--pre-commit] | Claude Code也一样: .mcp.json, (中文(简体) ), .claude/settings.json,则 CLAUDE.md 块和 .grum/AGENTS.md。 。 。 . |
grum check --staged # drift in the blocks staged for commit
grum check --files src/Hero.tsx # only these paths
grum check --json # project, cache time, known count, findings, discovered icons
grum check --no-review # print the report and do not ask
grum check --cursor # open the findings in Cursor
grum check --offline # the cached contract, no network
grum check --root apps/web # the app lives in a subdirectory
grum check --report # also post this run to Grum
grum check --ci # fail on open or rejected drift, and post the run
grum check --strict # like --ci, and also fail while a review is pending
--ci 财务报告和审定财务报表 --report 显示在最近检查的漂流页面上, 每个分支有一个最新运行。 CI,JSON, 舞台,和代理运行 从不打开菜单, 也从不迅速.
grum hook 财务报告和审定财务报表 grum mcp 是Cursor、Codex和Claude代码运行的切入点。 你不能自己叫他们.
反馈. 当被困住,迷惑,或问经纪人如何使用格鲁姆时,经纪人会用自己的话向格鲁姆团队发送一个简短的总结,其中少数关于格鲁姆的转折会引领到那里,一个格鲁姆工具会自己报告失败. 每份报告中也包括了该聊天中最后几个格鲁姆工具的调用(代理问格鲁姆的问题和格鲁姆回答的,剪接),因此团队可以看到哪里出了问题. 它在背景中运行 永远不会拖慢你的工作。 代理人被告知永远不要包含代码,文件内容,或秘密,而你的签入令牌从不发送;您的家庭文件夹,电子邮件,以及外观隐秘的字符串首先被取出. 设定 GRUM_FEEDBACK=off 来阻止它.
对于 setup 财务报告和审定财务报表 doctor, (中文(简体) ), <agent> 实值 cursor, (中文(简体) ), codex, (中文(简体) ), claude 或者说 generic。 。 。 .
卸载
npx @grum-os/cli uninstall
在仓库里运行它。 它先问( Enter 表示否),然后删除:
- 从此寄存器 : Grum 的光标、 Codex 和 Claude 代码条目( 仅 Grum; 其余文件保留), 承诺前检查
.gitignore线条,和.grum/。 。 。 . - 从此计算机: 每一个签入, 结束在格鲁姆太, 所以符号停止工作
~/.config/grum(签名入内,抓取浏览器数据,日志).
你的工作空间,合同和评论 留在格鲁姆。 你设置的其他寄存器保存其文件: 在每个寄存器中运行 . --yes 跳过问题,用于脚本和代理.
如果您在全球安装了 CLI, 也运行 npm uninstall -g @grum-os/cli。 。 。 .
环境
| 变量 | 它会做什么 |
|---|---|
GRUM_TOKEN | 注册CI。 覆盖此计算机上保存的符号 . |
GRUM_API_ORIGIN | 跟别的人说话 https://app.grum.so。一个 http 或者说 https 源代码,在 URL 中没有用户或密码. |
GRUM_NO_BROWSER | 登录时不要打开浏览器 。 代码和链接仍然被打印出. |
GRUM_FEEDBACK | off 不向格鲁姆团队发送反馈或工具错误报告. |