Przewodnik poleceń CLI dla AppCAT 7

W tym artykule opisano użycie polecenia CLI usługi AppCAT.

Komendy

appcat analyze

Poniższe sekcje zawierają szczegółowy opis dostępnych appcat analyze parametrów wiersza polecenia.

Wymagane parametry

Parametry opcjonalne

Obsługiwane źródła

Parametr --list-sources przedstawia następujące technologie źródłowe:

Obsługiwane obiekty docelowe

Parametr --list-targets przedstawia następujące technologie docelowe:

Obsługiwane systemy operacyjne

Parametr --list-os przedstawia następujące systemy operacyjne:

Obsługiwane możliwości

Parametr --list-capabilities przedstawia następujące możliwości:

Konfigurowanie ignorowania plików

W ścieżce instalacji CLI AppCAT można skonfigurować plik .appcat-ignore, aby wykluczyć określone foldery lub ścieżki podczas uruchamiania polecenia appcat analyze.

Parametry globalne

Przykłady

• Analizowanie katalogu kodu źródłowego:

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

• Analizowanie katalogu kodu źródłowego przy użyciu określonych technologii źródłowych i docelowych:

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

• Analizowanie katalogu kodu źródłowego przy użyciu dodatkowych reguł niestandardowych:

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

• Analizowanie katalogu kodu źródłowego przy użyciu tylko reguł niestandardowych bez domyślnych zestawów reguł:

  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
  

• Analizuj i dodaj dodatkową analizę aplikacji do istniejącego katalogu wyjściowego i raportu statycznego.

  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>
  

• Przeanalizuj katalog kodu źródłowego z określonym źródłem, aby połączyć technologie docelowe, możliwości i system operacyjny:

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

  Parametry --target, --capabilitiesi -os są łączone z warunkiem, co oznacza, że reguły muszą być jednocześnie zgodne z AND następującymi kryteriami:

  • Usługa platformy Azure, taka jak azure-aks, azure-appservicelub azure-container-apps.
  • Możliwość wykrywania problemów z konteneryzacją.
  • Platforma systemu operacyjnego Windows.

• Przeanalizuj katalog kodu źródłowego i zapamiętaj wykryte wiersze kontekstu z niestandardowymi numerami wierszy.

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

  Poniższy zrzut ekranu przedstawia przykład użycia polecenia --context-lines-number 3:

  

• Ogranicz zawartość raportu bez fragmentów kodu:

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

  Po --code-snips-number -1 ustawieniu fragmenty kodu nie są eksportowane do raportu. To zachowanie pomaga zapobiec dołączaniu poufnych danych.

  

  Możesz również sprawdzić właściwość metadata.privacyMode w report.json.

  PrivacyMode wartości:

  • Bez ograniczeń — raport zawiera fragmenty kodu.
  • Ograniczone — raport nie zawiera fragmentów kodu.

przekształcenie appcat

Konwertuje reguły XML Windup na YAML.

Wymagane parametry

Parametry globalne

Przykłady

Poniższy przykład konwertuje regułę XML windup na YAML:

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

wersja appcat

Drukuje wersję narzędzia.

appcat version