Checks Code Compliance 使用入门

代码合规性通过 Checks CLI 使用,结果会上传到 Checks 控制台。

安装 Code Compliance

首先,请按照 Checks CLI 的安装说明操作。

安装完成后,您将能够运行代码合规性命令:

checks code <command>

扫描项目

安装 Checks Code Compliance 后,您可以扫描代码库,了解敏感数据的收集、共享或处理方式。

如需使用代码合规性 CLI 扫描代码库代码,请使用 checks code scan 命令。

例如,如需测试位于文件夹 repositories/personal 中的 my-swift-app 代码库,请执行以下操作:

checks code scan repositories/personal/my-swift-app

默认情况下,代码合规性检查会将结果以文本格式输出到终端。

以 JSON 格式输出测试结果

如需在终端中以 JSON 格式导出结果,请执行以下操作:

checks code scan PATH --format=json > ./checks-code-results

如需将结果导出为 JSON 格式并保存到本地文件,请执行以下操作:

checks code scan PATH --format=json > ./checks-code-results.json

以 HTML 格式输出测试结果

如需在终端中以 HTML 格式导出结果,请执行以下操作:

checks code scan PATH --format=html > ./checks-code-results

如需将结果导出为 HTML 格式并保存到本地文件,请执行以下操作:

checks code scan PATH --format=html > ./checks-code-results.html

更多帮助

运行 checks code scan --help

设置自动扫描

如需了解如何设置自动代码合规性扫描,请参阅我们的 CI/CD 概览文档。

获取支持

如果您需要有关 Checks Code Compliance 或 Checks 的一般帮助,请随时发送电子邮件至 checks-support@google.com。