CLI-kommandoguide för AppCAT 7

Den här artikeln beskriver appCAT CLI-kommandoanvändningen.

Kommandon

AppCat analysera

Följande avsnitt innehåller en detaljerad beskrivning av de tillgängliga appcat analyze kommandoradsparametrarna.

Obligatoriska parametrar

Valfria parametrar

Källor som stöds

Parametern --list-sources visar följande källtekniker:

Mål som stöds

Parametern --list-targets visar följande måltekniker:

Operativsystem som stöds

Parametern --list-os visar följande operativsystem:

Funktioner som stöds

Parametern --list-capabilities visar följande funktioner:

Konfigurera ignorera filer

I installationssökvägen för AppCAT CLI kan du konfigurera .appcat-ignore-filen för att undanta angivna mappar eller sökvägar när du kör appcat analyze kommandot.

Globala parametrar

Exempel

• Analysera en källkodskatalog:

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

• Analysera en källkodskatalog med specifika käll- och måltekniker:

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

• Analysera en källkodskatalog med extra anpassade regler:

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

• Analysera en källkodskatalog med endast anpassade regler, utan standardregleruppsättningar:

  appcat analyze \
      --input /path/to/source \
      --output /path/to/output \
      --enable-default-rulesets=false \
      --rules /path/to/rules
      --target azure-aks,azure-appservice,azure-container-apps
  

• Analysera och lägga till mer programanalys i en befintlig utdatakatalog och statisk rapport:

  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>
  

• Analysera en källkodskatalog med en specifik källa för att kombinera måltekniker, funktioner och operativsystem:

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

  Parametrarna --target, --capabilitiesoch -os kombineras med ett AND villkor, vilket innebär att reglerna måste matcha följande villkor samtidigt:

  • En Azure-tjänst som azure-aks, azure-appserviceeller azure-container-apps.
  • Möjligheten att identifiera containeriseringsproblem.
  • Windows OS-plattformen.

• Analysera en källkodskatalog och behåll de identifierade kontextraderna med anpassade radnummer:

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

  Följande skärmbild visar ett exempel på hur du använder --context-lines-number 3:

  

• Begränsa rapportinnehåll utan kodfragment:

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

  När --code-snips-number -1 har angetts exporteras inte kodfragment till rapporten. Det här beteendet hjälper till att förhindra att känsliga data inkluderas.

  

  Du kan också kontrollera egenskapen metadata.privacyMode i report.json.

  PrivacyMode värden:

  • Obegränsad – rapporten innehåller kodfragment.
  • Begränsad – rapporten innehåller inte kodfragment.

Appcat-transformering

Konverterar Windup XML-regler till YAML.

Obligatoriska parametrar

Globala parametrar

Exempel

Följande exempel konverterar en windup XML-regel till YAML:

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

appcat-version

Skriver ut verktygsversionen.

appcat version