CLI-Befehlshandbuch für AppCAT 7

In diesem Artikel wird die Verwendung des AppCAT CLI-Befehls beschrieben.

Befehle

Appcat-Analyse

Die folgenden Abschnitte enthalten eine detaillierte Beschreibung der verfügbaren appcat analyze Befehlszeilenparameter.

Erforderliche Parameter

Optionale Parameter

Unterstützte Quellen

Der --list-sources Parameter zeigt die folgenden Quelltechnologien:

Unterstützte Ziele

Der --list-targets Parameter zeigt die folgenden Zieltechnologien:

Unterstützte Betriebssysteme

Der --list-os Parameter zeigt die folgenden Betriebssysteme:

Unterstützte Funktionen

Der --list-capabilities Parameter zeigt die folgenden Funktionen:

Konfigurieren von Ignorieren von Dateien

Im AppCAT CLI-Installationspfad können Sie die APPCAT-Ignore-Datei so konfigurieren, dass angegebene Ordner oder Pfade beim Ausführen des appcat analyze Befehls ausgeschlossen werden.

Globale Parameter

Beispiele

• Analysieren eines Quellcodeverzeichnisses:

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

• Analysieren Sie ein Quellcodeverzeichnis mit bestimmten Quell- und Zieltechnologien:

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

• Analysieren Sie ein Quellcodeverzeichnis mit zusätzlichen benutzerdefinierten Regeln:

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

• Analysieren Sie ein Quellcodeverzeichnis nur mit benutzerdefinierten Regeln, ohne Standardregeln:

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

• Analysieren und Hinzufügen weiterer Anwendungsanalysen zu einem vorhandenen Ausgabeverzeichnis und statischen Bericht:

  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>
  

• Analysieren Sie ein Quellcodeverzeichnis mit einer bestimmten Quelle, um Zieltechnologien, Funktionen und Betriebssystem zu kombinieren:

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

  Die --target, --capabilitiesund -os die Parameter werden mit einer AND Bedingung kombiniert, d. h., dass die Regeln gleichzeitig den folgenden Kriterien entsprechen müssen:

  • Ein Azure-Dienst wie azure-aks, azure-appservice oder azure-container-apps.
  • Die Funktion zum Erkennen von Containerisierungsproblemen.
  • Die Windows-Betriebssystemplattform.

• Analysieren Sie ein Quellcodeverzeichnis, und behalten Sie die erkannten Kontextzeilen mit benutzerdefinierten Zeilennummern bei:

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

  Der folgende Screenshot zeigt ein Beispiel für die Verwendung von --context-lines-number 3:

  

• Einschränken von Berichtsinhalten ohne Codeausschnitte:

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

  Wenn --code-snips-number -1 festgelegt ist, werden Codeausschnitte nicht in den Bericht exportiert. Dieses Verhalten verhindert, dass vertrauliche Daten einbezogen werden.

  

  Sie können die metadata.privacyMode Eigenschaft auch in report.jsonüberprüfen.

  PrivacyMode-Werte:

  • Uneingeschränkt – der Bericht enthält Codeausschnitte.
  • Eingeschränkt – der Bericht enthält keine Codeausschnitte.

Appcat-Umwandlung

Konvertiert Windup-XML-Regeln in YAML.

Erforderliche Parameter

Globale Parameter

Beispiele

Im folgenden Beispiel wird eine XML-Regel von Windup nach YAML konvertiert.

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

AppCat-Version

Druckt die Toolversion.

appcat version