Sandworm Audit 使用教程

Sandworm Audit 使用教程

sandworm-auditSecurity & License Compliance For Your App's Dependencies 🪱项目地址:https://gitcode.com/gh_mirrors/sa/sandworm-audit

项目介绍

Sandworm Audit 是一个用于审计应用程序依赖项的安全性和许可证合规性的开源工具。它可以帮助开发者识别和修复依赖项中的安全漏洞和许可证问题，确保应用程序的安全性和合规性。

项目快速启动

安装

Sandworm Audit 可以通过 npm、yarn 或 pnpm 全局安装：

npm install -g @sandworm/audit
# 或者
yarn global add @sandworm/audit
# 或者
pnpm add -g @sandworm/audit

运行

在应用程序的根目录中运行 Sandworm Audit：

sandworm-audit

确保目录中包含 manifest 文件和 lockfile。也可以直接运行而不安装：

npx @sandworm/audit@latest
# 或者
yarn dlx -p @sandworm/audit sandworm
# 或者
pnpm --package=@sandworm/audit dlx sandworm

可用选项

• -v, --version：显示版本号
• --help：显示帮助信息
• -o, --output-path：输出目录的路径（相对于应用程序路径），默认值为 sandworm
• -d, --include-dev：包含开发依赖项
• --sv, --show-versions：在图表名称中显示包版本
• -p, --path：要审计的应用程序路径
• --md, --max-depth：图表中表示的最大深度
• --ms, --min-severity：图表中表示的最小问题严重性
• --lp, --license-policy：自定义许可证策略 JSON 字符串
• -f, --from：从 "registry" 或 "disk" 加载数据，默认值为 "registry"
• --fo, --fail-on：失败策略 JSON 文件
• --show-tips：显示使用提示

应用案例和最佳实践

应用案例

Sandworm Audit 可以用于以下场景：

• 安全审计：定期审计应用程序的依赖项，确保没有安全漏洞。
• 许可证合规性检查：确保所有依赖项的许可证符合公司的合规性要求。
• 开源项目维护：帮助开源项目维护者管理依赖项，确保项目的安全性和合规性。

最佳实践

• 定期审计：建议定期运行 Sandworm Audit，特别是在发布新版本之前。
• 自定义许可证策略：根据公司或项目的需求，自定义许可证策略。
• 集成到 CI/CD 流程：将 Sandworm Audit 集成到 CI/CD 流程中，确保每次代码提交都经过安全性和合规性检查。

典型生态项目

Sandworm Audit 可以与以下生态项目结合使用：

• CI/CD 工具：如 Jenkins、GitHub Actions、GitLab CI 等。
• 包管理器：如 npm、yarn、pnpm 等。
• 代码仓库：如 GitHub、GitLab、Bitbucket 等。

通过与这些生态项目的结合，可以更高效地进行依赖项的安全性和合规性审计。

sandworm-auditSecurity & License Compliance For Your App's Dependencies 🪱项目地址:https://gitcode.com/gh_mirrors/sa/sandworm-audit