核心用法
wip-license-guard 是一款面向开发者自有仓库的许可证合规 CLI 工具,主要功能包括:
1. 仓库审计与修复
check [path]:按配置审计仓库,检测许可证文件、版权声明合规性check --fix:自动修复 LICENSE、CLA、版权头等问题
2. 初始化配置
init [path]:交互式设置许可证规则init --from-standard:一键应用 WIP Computer 默认配置(MIT/AGPL 双许可证模式)
3. README 许可证区块管理
readme-license:扫描单个仓库或仓库目录,支持三种模式- 审计模式:报告非标准、缺失或应移除的许可证区块
--dry-run:预览变更,不修改文件--fix:自动替换为 MIT/AGPLv3 标准双许可证区块,移除子工具 README 中的冗余区块
显著优点
- 双许可证专长:原生支持 MIT/AGPLv3 双许可证模式,满足开源商业化场景
- 批量处理能力:可同时处理目录下的多个仓库,适合组织级合规治理
- 安全预览机制:
--dry-run模式避免误操作,变更可控 - 标准化输出:基于 WIP Computer 组织实践,减少配置决策成本
潜在局限
- 适用范围窄:仅设计用于"自己的仓库",不适用于第三方依赖许可证审计(非 SCA 工具)
- Node 依赖:要求 Node.js 和 Git 环境,对纯 Python/Go 项目团队增加工具链负担
- 配置锁定:
--from-standard硬编码组织预设,灵活性不足时仍需交互配置 - 维护状态存疑:v1.0.0 版本较旧,长期更新承诺未明确
适合人群
- 维护多仓库的开源组织/个人开发者
- 采用 MIT/AGPL 双许可证策略的技术团队
- 需要在发布前批量标准化版权声明的 DevOps 工程师
常规风险
- 版权误判风险:自动修复可能覆盖自定义许可声明,建议始终先用
--dry-run验证 - Git 操作风险:
--fix模式直接修改工作区文件,未内置暂存/回滚机制 - 合规≠法律安全:工具仅保证文件存在性和格式,不替代律师审核