跳转到主要内容
本指南让您在 5 分钟内完成从零到一次完整审查的流程。
1

安装

安装 CLI 并将 Kodus 技能部署到所有检测到的 AI 代理（Claude Code、Cursor、Codex、Windsurf）：
curl -fsSL https://review-skill.com/install | bash
需要 Node.js >= 20.0.0。
验证安装：
kodus --version
kodus status
2

认证

根据您的使用场景选择。您也可以跳过认证，直接运行 kodus review — 试用模式每日有使用次数限制。
使用个人账户登录：
kodus auth login
令牌保存在 ~/.kodus/credentials.json，并自动刷新。
自托管 Kodus？ 在认证前先指向您的 API：
export KODUS_API_URL=https://kodus-api.yourcompany.com
除 localhost 外必须使用 HTTPS。
确认认证状态：
kodus auth status
3

运行第一次审查

在包含未提交变更的任意 git 仓库中：
kodus review
CLI 会分析您的工作目录差异，打印摘要，并（在交互模式下）允许您逐文件浏览、预览建议修复并应用。常见变体：
kodus review --staged             # 仅审查暂存文件
kodus review --branch main        # 将当前分支与 main 对比
kodus review --commit abc123      # 分析单个提交
kodus review --fix                # 自动应用所有可修复问题
kodus review --prompt-only        # 为 AI 代理优化的紧凑输出
kodus review --fail-on error      # 在 error 或更高级别时非零退出（适合 CI）
工作目录审查（默认）和 --staged 会将文件内容内联到请求中，以便后端看到未提交的变更。--branch 和 --commit 模式跳过内联，因为后端可以自行获取相应提交 — 这使得这些模式在大型分支上表现良好。
4

选择下一步

根据您的目标：

每次推送自动审查

使用 kodus hook install 安装 pre-push 钩子。

在 CI 中运行审查

GitHub Actions、GitLab CI 及通用流水线示例。

接入 AI 代理

将 --prompt-only 接入 Claude Code、Cursor 或 Codex，实现自主修复循环。

配置仓库

从 CLI 管理忽略文件、基础分支及审查设置。

​
环境变量

这些环境变量用于配置 CLI 行为。
变量描述
KODUS_API_URLAPI 端点（默认：https://api.kodus.io）
KODUS_TEAM_KEY团队共享访问和 AI 代理的团队密钥
KODUS_TOKEN通过 kodus auth token 生成的 CI/CD 令牌
KODUS_VERBOSE设置为 true 以启用详细输出
KODUS_SKIP_HOOK设置为 1 以跳过单次 git push 的 pre-push 钩子
KODUS_REQUEST_TIMEOUT_MIN每次请求的超时时间（分钟，默认：60）
CF_ACCESS_CLIENT_IDCloudflare Access 客户端 ID（用于 Zero Trust 后的 API）
CF_ACCESS_CLIENT_SECRETCloudflare Access 客户端密钥
关于自托管配置、令牌和 Cloudflare Access，请参考 自托管配置。

​
故障排查

遇到错误？查看 故障排查指南 了解常见症状和解决方案。