使用指南

把它当作你已经在用的 AI agent 的发布侧车。

Agent Guardrails 不替代 Codex、Claude Code、OpenCode、Cursor 或你的终端。它补上的是发布控制层:任务边界、上线决策、证据保存和可读回执。

从这里开始

两条路径,同一个工作流。

核心工作流不变。OSS 提供有边界的门禁,Pro 在你有预览访问时再补上本地 Workbench、证据引导和发布回执。

如果你先从 OSS 开始

今天就可以使用公开 OSS 包。先创建任务契约,再让 agent 在范围内改代码,最后在你信任这次改动前运行门禁。

npx agent-guardrails plan --task "..."
如果你已经拿到 Pro 预览访问

按预览访问邮件里的说明启用 Pro,然后在每次受控检查后打开本地 Workbench。它应该先回答发布问题,再让你看细节。

npx agent-guardrails pro workbench --open
谁做什么

用户负责决策,agent 负责机械工作。

你不应该盯着 JSON,也不应该手工拼一份发布清单。coding agent 负责跑命令、保存证明、重跑门禁;人负责看结论和剩余风险。

用户负责

定义任务、阅读 Workbench 或报告、判断证据是否足够,并最终决定是否合并或部署。

Agent 负责

保持范围、运行证明命令、把证据保存到 `.agent-guardrails/evidence/`、重新运行门禁,并报告结论是否变化。

真实流程

从 prompt 到发布判断,只保留五步。

用户不应该盯着 JSON。机械工作交给 agent,用户只需要看决策、证据和剩余风险。

01

限定任务

在 AI agent 开始改代码前创建任务契约,记录目标文件、允许路径、必跑命令和证据路径。

npx agent-guardrails plan --task "..."
02

让 agent 工作

继续正常使用 Codex、Claude Code、OpenCode、Cursor 或其他 agent。Agent Guardrails 留在发布侧车位置,而不是替换它们。

避免无关改动越界
03

运行门禁

代码改完后运行检查。OSS 会发现范围和验证问题,启用 Pro 后再补上上线结论。

npx agent-guardrails check --review
04

打开 Workbench

先看本地 Workbench。它会回答“能不能上线”、给出一个下一步证明,并生成交给 agent 的提示。

npx agent-guardrails pro workbench --open
05

保存证明

让 agent 运行或观察证明、保存证据、重新运行门禁,并报告结论是否发生变化。

回执留在仓库里
命令负担

现在正常一轮里,人通常只输入两三个命令。

它目前仍然是 CLI 优先的工作流,但不应该让人觉得命令很多。重复劳动应该交给 agent:跑证明、保存截图或日志、重跑门禁、写证据说明。

1. 每个任务一次

先用 npx agent-guardrails plan --task "..." 创建任务契约。

2. 改动完成后一次

让 agent 完成范围内改动后,运行 npx agent-guardrails check --review

3. 如果启用了 Pro

打开 npx agent-guardrails pro workbench --open,看清下一步,再把机械工作交回给 agent。

真实产品素材

用户实际会看到什么。

这些都来自仓库真实 fixture 引擎。给人看的第一层应该是 Workbench 和报告,而不是一团 JSON。

真实 Agent Guardrails Pro Workbench 截图
Workbench 是给人看的界面:上线结论、下一步证明、可见验证和 agent 交接。
Agent 交接

Agent 拿到的是一个任务,不是模糊清单。

生成的提示会要求 agent 保持范围、运行证明、把证据保存到 `.agent-guardrails/evidence/`、重跑门禁,并报告结论变化。

本地分析保持在你的仓库工作流里。
真实 Agent Guardrails Pro 上线报告截图
上线报告会在 coding agent 离开后,留下可读的决策链路。
先给人看

Workbench 和报告负责解释改了什么、为什么门禁拦住、下一步最值得补什么证据。

自动化仍然可用

JSON 输出仍然保留给 CI、agent 和审计,但它应该放在人类可读决策界面的后面。

MCP 集成

当 agent 支持 MCP,闭环会更顺。

安装 Pro 后,OSS MCP server 可以暴露 Pro 提供的工具。这样 agent 可以直接读取 Workbench、保存证据说明,并在重跑门禁后记录证明配方是否有效,你不需要每一步都手工复制。

读取

`pro_read_workbench` 返回当前发布结论、证明队列和 agent 交接信息。

保存

`pro_capture_evidence_note` 把结构化证明说明和产物路径追加进仓库证据文件。

学习

`pro_record_proof_outcome` 记录证明是否真的有用,让仓库记忆越用越准。