AppCAT 7 的 CLI 命令指南

本文介绍 AppCAT CLI 命令用法。

Commands

appcat 分析

以下部分提供了可用 appcat analyze 命令行参数的详细说明。

必需的参数

可选参数

支持的源

该 --list-sources 参数显示了以下源技术：

支持的目标

该 --list-targets 参数显示了以下目标技术：

受支持的操作系统

该 --list-os 参数显示以下操作系统：

支持的功能

该 --list-capabilities 参数显示以下功能：

配置忽略文件

在 AppCAT CLI 安装路径中，可以将 .appcat-ignore 文件配置为在运行 appcat analyze 命令时排除指定的文件夹或路径。

全局参数

Examples

• 分析源代码目录：

  appcat analyze --input <path-to-source> --output <path-to-output>
  

• 使用特定源和目标技术分析源代码目录：

  appcat analyze \
      --input <path-to-source> \
      --output <path-to-output> \
      --source springboot \
      --target azure-aks,azure-appservice,azure-container-apps
  

• 使用额外的自定义规则分析源代码目录：

  appcat analyze --input <path-to-source> --output <path-to-output> --rules <path-to-rules>
  

• 仅使用自定义规则分析源代码目录，而不使用默认规则集：

  appcat analyze \
      --input /path/to/source \
      --output /path/to/output \
      --enable-default-rulesets=false \
      --rules /path/to/rules
  

• 分析和向现有输出目录和静态报表添加更多应用程序分析：

  appcat analyze \
      --input=<path-to-source-A>,<path-to-source-B>,<path-to-source-C> \
      --output=<path-to-output-ABC> \
      --target=<target-name>
  appcat analyze 
      --bulk \
      --input=<path-to-source-D> \
      --output=<path-to-output-ABC> \
      --target=<target-name>
  appcat analyze \
      --bulk \
      --input=<path-to-source-E> \
      --output=<path-to-output-ABC> \
      --target=<target-name>
  

• 分析包含特定源代码的目录，以整合目标技术、功能和操作系统。

  appcat analyze \
      --input <path-to-source> \
      --output <path-to-output> \
      --source springboot \
      --target azure-aks,azure-appservice,azure-container-apps
      --capability containerization
      --os windows
  

  --target、--capabilities 和 -os 参数与 AND 条件结合使用，这意味着规则必须同时符合以下条件：

  • Azure 服务，例如 azure-aks， azure-appservice或 azure-container-apps。
  • 检测容器化问题的功能。
  • Windows OS 平台。

• 分析源代码目录，并使用自定义行号保留检测到的上下文行：

  appcat analyze \
      --input <path-to-source> \
      --output <path-to-output> \
      --context-lines-number <line-number>
  

  以下屏幕截图显示了使用 --context-lines-number 3示例：

  

• 在不带代码片段的情况下限制报表内容：

  appcat analyze \
      --input <path-to-source> \
      --output <path-to-output> \
      --code-snips-number -1
  

  当设置 --code-snips-number -1 时，代码片段不会导出到报表。 此行为有助于防止敏感数据被包含。

  

  您还可以检查metadata.privacyMode中的report.json属性。

  PrivacyMode 值：

  • 不受限制 - 报表包含代码片段。
  • 受限 - 报表不包含代码片段。

appcat 转换

将 Windup XML 规则转换为 YAML。

必需的参数

全局参数

Examples

以下示例将 windup XML 规则转换为 YAML：

appcat transform rules --input <path-to-rule> --output <path-to-output-folder>

appcat 版本

显示工具的版本信息。

appcat version