CLI command guide for AppCAT 7

This article describes the AppCAT CLI command usage.

Commands

appcat analyze

The following sections provide a detailed description of the available appcat analyze command line parameters.

Required parameters

Optional parameters

Supported sources

The --list-sources parameter shows the following source technologies:

Supported targets

The --list-targets parameter shows the following target technologies:

Supported operating systems

The --list-os parameter shows the following operating systems:

Supported capabilities

The --list-capabilities parameter shows the following capabilities:

Configure ignore files

In the AppCAT CLI install path, you can configure the .appcat-ignore file to exclude specified folders or paths when running the appcat analyze command.

Global parameters

Examples

• Analyze a source code directory:

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

• Analyze a source code directory with specific source and target technologies:

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

• Analyze a source code directory with extra custom rules:

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

• Analyze a source code directory using only custom rules, without default rulesets:

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

• Analyze and add more application analysis to an existing output directory and static report:

  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>
  

• Analyze a source code directory with specific source to combine target technologies, capabilities, and operating system:

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

  The --target, --capabilities, and -os parameters are combined with an AND condition, meaning that the rules must simultaneously match the following criteria:

  • An Azure service such as azure-aks, azure-appservice, or azure-container-apps.
  • The capability to detect containerization issues.
  • The Windows OS platform.

• Analyze a source code directory and keep the detected context lines with custom line numbers:

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

  The following screenshot shows an example of using --context-lines-number 3:

  

• Restrict report content without code snippets:

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

  When --code-snips-number -1 is set, code snippets aren't exported to the report. This behavior helps prevent sensitive data from being included.

  

  You can also check the metadata.privacyMode property in report.json.

  PrivacyMode values:

  • Unrestricted – the report includes code snippets.
  • Restricted – the report doesn't include code snippets.

appcat transform

Converts Windup XML rules to YAML.

Required parameters

Global parameters

Examples

The following example converts a windup XML rule to YAML:

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

appcat version

Prints the tool version.

appcat version