MonkeyScan 文档CLI
在本地开发或自动化流程中发起全量扫描和差分 Review。
CLI 适合把检查放到本地开发或自动化流程中。Web 端“设置”页生成的 CLI API Key 只完整展示一次；生成新 Key 会立即使旧 Key 失效，泄露后应撤销并重新生成。
安装
macOS 或 Linux：
curl -fsSL https://raw.githubusercontent.com/chaitin/chaitin-cli/main/skills/chaitin-cli/scripts/install-chaitin-cli.sh | bashWindows 可从 chaitin/chaitin-cli 的 GitHub Releases 下载对应版本并加入 PATH。
配置身份
chaitin-cli monkeyscan auth set-key
chaitin-cli monkeyscan auth status也可以使用环境变量：
export MONKEYSCAN_API_KEY="<your-api-key>"不要把 API Key 写入仓库、日志或公开的 CI 配置。
全量扫描
# 扫描当前目录
chaitin-cli monkeyscan scan --path .
# 扫描已有压缩包
chaitin-cli monkeyscan scan --file ./source.zip
# 查看任务与结果
chaitin-cli monkeyscan scan list
chaitin-cli monkeyscan scan result
chaitin-cli monkeyscan scan result <task_group_id> --full --output report.md本地目录打包时会排除 Git 元数据和 MonkeyScan 本地结果目录。目录、压缩包和仓库输入互斥；未指定输入时默认扫描当前目录。
本地差分 Review
# 未暂存改动
chaitin-cli monkeyscan review --type uncommitted
# 已暂存改动
chaitin-cli monkeyscan review --type staged
# 当前分支相对目标分支的已提交改动
chaitin-cli monkeyscan review --type committed --base origin/main
# 只预览范围，不上传代码、不创建任务
chaitin-cli --dry-run monkeyscan review --type staged本地 Review 仍要求当前仓库能匹配到账号已接入且授权有效的仓库。空 diff 不会创建任务；超出限制时 CLI 会返回明确原因。
CLI 的结果目录可能包含代码片段和修复建议，应加入 .gitignore，不要提交到业务仓库。