Guide de commande CLI pour AppCAT 7

Cet article décrit l’utilisation de la commande CLI AppCAT.

Commandes

analyser appcat

Les sections suivantes fournissent une description détaillée des paramètres de ligne de commande disponibles appcat analyze .

Paramètres obligatoires

Paramètres facultatifs

Sources prises en charge

Le --list-sources paramètre affiche les technologies sources suivantes :

Cibles prises en charge

Le --list-targets paramètre affiche les technologies cibles suivantes :

Systèmes d'exploitation pris en charge

Le --list-os paramètre affiche les systèmes d’exploitation suivants :

Fonctionnalités prises en charge

Le --list-capabilities paramètre affiche les fonctionnalités suivantes :

Configurer les fichiers ignorés

Dans le chemin d’installation de l’interface CLI AppCAT, vous pouvez configurer le fichier .appcat-ignore pour exclure les dossiers ou chemins spécifiés lors de l’exécution de la appcat analyze commande.

Paramètres globaux

Exemples

• Analysez un répertoire de code source :

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

• Analysez un répertoire de code source avec des technologies sources et cibles spécifiques :

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

• Analysez un répertoire de code source avec des règles personnalisées supplémentaires :

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

• Analysez un répertoire de code source à l’aide de règles personnalisées uniquement, sans ensembles de règles par défaut :

  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
  

• Analysez et ajoutez d’autres analyses d’application à un répertoire de sortie existant et à un rapport statique :

  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>
  

• Analysez un répertoire de code source avec une source spécifique pour combiner les technologies cibles, les fonctionnalités et le système d’exploitation :

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

  Les paramètres --target, --capabilities et -os sont combinés avec une condition AND, ce qui signifie que les règles doivent simultanément correspondre aux critères suivants :

  • Un service Azure tel que azure-aks, azure-appserviceou azure-container-apps.
  • Capacité à détecter les problèmes de conteneurisation.
  • Plateforme du système d’exploitation Windows.

• Analysez un répertoire de code source et conservez les lignes de contexte détectées avec des numéros de ligne personnalisés :

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

  La capture d’écran suivante montre un exemple d’utilisation --context-lines-number 3:

  

• Restreindre le contenu du rapport sans extraits de code :

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

  Quand --code-snips-number -1 elle est définie, les extraits de code ne sont pas exportés vers le rapport. Ce comportement permet d’empêcher l’inclusion de données sensibles.

  

  Vous pouvez également vérifier la metadata.privacyMode propriété dans report.json.

  PrivacyMode valeurs :

  • Sans restriction : le rapport inclut des extraits de code.
  • Restreint : le rapport n’inclut pas d’extraits de code.

transformer appcat

Convertit les règles XML Windup en YAML.

Paramètres obligatoires

Paramètres globaux

Exemples

L’exemple suivant convertit une règle XML windup en YAML :

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

version appcat

Imprime la version de l’outil.

appcat version