使用说明

基本用法

安装单个包

pipguard install requests

pipguard 会先下载并扫描，再从已扫描的本地缓存安装。默认输出采用摘要优先： 展开 CRITICAL / HIGH / MEDIUM 详情，LOW 仅显示包级计数，CLEAN 只计入汇总。

从 requirements.txt 安装

pipguard install -r requirements.txt

非交互模式（CI 推荐）

pipguard install --yes -r requirements.txt

常用参数

• --yes：自动确认 MEDIUM/LOW 风险（适合 CI）
• --allow pkg1,pkg2：允许指定包将 HIGH 降级为 MEDIUM
• --allow-sdist：允许 sdist（默认不允许）
• --verbose：显示完整扫描明细，包括 LOW 文件详情与 CLEAN 包列表
• --show-pip-output：显示原始 pip 安装输出
• --policy path/to/pipguard.toml：使用策略文件

输出与行为

• 检测到 CRITICAL/HIGH：阻断安装，退出码 1
• 检测到 MEDIUM/LOW：提示确认（或 --yes 自动继续）
• 全部 CLEAN：在摘要中显示计数，退出码 0
• 扫描失败：退出码 2

默认会静默成功安装时的原始 pip install 日志；如需查看完整安装输出， 可加 --show-pip-output。

更多细节请参考：风险等级 与 退出码。