快速开始

文档

从注册到第一份评审报告,三分钟即可完成。下面是常用入口。

BorderCollie 控制台猫狗试验室
已同步
接入清单从首仓到 CI 门禁
  1. 创建租户与 API Key
  2. 接入 Git 平台仓库
  3. 配置策略和通知
  4. 在 CI 中运行 collie
$ collie review --base main --head HEAD
✓ diff parsed
✓ policy loaded
→ review task created

接入第一个仓库

在控制台「项目」中粘贴仓库地址 + 平台 token,BorderCollie 会自动建立连接并注册 webhook。

$ collie init --token $BC_TOKEN
$ collie repo add https://github.com/your-org/your-repo
$ collie review --pr 1234

配置 Webhook

BorderCollie 接收以下平台的 webhook,签名校验默认开启;secret 留空则跳过校验(仅开发环境)。

POST https://review.woofcloud.com/api/v1/webhook/github
X-Hub-Signature-256: sha256=...
Content-Type: application/json

门禁策略

policy.yml 决定哪些风险等级会拦截 merge、是否强制 license/secret 通过。修改后立即生效,无需重启。

policy:
  block_severity: high     # critical/high 自动拦截
  require_secret_clean: true
  license_allowlist: [MIT, Apache-2.0, BSD-3-Clause]

安装 collie CLI

# 从源码安装(需要 Rust 1.74+)
cd border-collie-cli && cargo install --path .

# 在控制台「设置 → API Key」生成 key,然后初始化
collie init --api https://review.woofcloud.com --key <YOUR_API_KEY>
collie whoami   # 查看绑定租户与套餐

管理仓库 / 模型 / 审查角色

# 仓库
collie repo list
collie repo add --name acme/web --url https://github.com/acme/web --platform github --token ghp_xxx
collie repo toggle 12   # 启用或禁用
collie repo rm 12

# 模型
collie model list
collie model add --name claude-3.5 --provider anthropic \
             --api-url https://api.anthropic.com/v1 --api-key sk-ant-xxx
collie model use 7      # 设为默认

# 审查角色 / Reviewer
collie agent list
collie agent toggle 3
collie reviewer list

本地一键评审

# 1. 本地 diff:提交 git diff base..head
collie review --base main --head HEAD

# 2. stdin:脱离 git,直接传入 diff
git diff main..feat | collie review --diff-from-stdin --repo your-org/your-repo

# 3. 远端拉取:后端使用仓库 access_token 拉取 base..branch
collie review-branch --repo acme/web --branch feature/x

# 4. 查询与重试
collie status 12345     # 简洁状态
collie result 12345     # 详细结果(含 findings)
collie list --size 20   # 最近任务
collie retry 12345      # 重试失败任务

# 失败或 blocked 返回退出码 2,便于 CI 直接 fail

配额 / 日志 / 补全

# 配额 / 用量
collie usage
collie plans              # 公开套餐目录

# 模型调用日志(CI 调试用)
collie logs --task-id 12345
collie logs --status failed --size 30

# 本地配置 + shell 补全
collie config
collie completion bash > ~/.bordercollie-completion.bash
echo 'source ~/.bordercollie-completion.bash' >> ~/.bashrc

接入 CI/CD

通过 `collie CLI` 在 CI 中执行评审:失败会以非零退出码标记 pipeline。