Guia de comandos da CLI para AppCAT 7

Este artigo descreve o uso do comando AppCAT CLI.

Comandos

Análise do AppCat

As seções a seguir fornecem uma descrição detalhada dos parâmetros de linha de comando disponíveis appcat analyze .

Parâmetros necessários

Parâmetros opcionais

Origens suportadas

O --list-sources parâmetro mostra as seguintes tecnologias de origem:

Alvos suportados

O --list-targets parâmetro mostra as seguintes tecnologias de destino:

Sistemas operativos suportados

O --list-os parâmetro mostra os seguintes sistemas operacionais:

Capacidades suportadas

O --list-capabilities parâmetro mostra os seguintes recursos:

Configurar ignorar arquivos

No caminho de instalação da CLI do AppCAT, você pode configurar o arquivo .appcat-ignore para excluir pastas ou caminhos especificados ao executar o appcat analyze comando.

Parâmetros globais

Exemplos

• Analise um diretório de código-fonte:

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

• Analise um diretório de código-fonte com tecnologias de origem e destino específicas:

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

• Analise um diretório de código-fonte com regras personalizadas extras:

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

• Analise um diretório de código-fonte usando apenas regras personalizadas, sem conjuntos de regras padrão:

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

• Analise e adicione mais análise de aplicativos a um diretório de saída existente e a um relatório estático:

  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>
  

• Analise um diretório de código-fonte com código-fonte específico para combinar tecnologias, recursos e sistema operacional de destino:

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

  Os --targetparâmetros , --capabilities, e -os são combinados com uma AND condição, o que significa que as regras devem corresponder simultaneamente aos seguintes critérios:

  • Um serviço do Azure como azure-aks, azure-appserviceou azure-container-apps.
  • A capacidade de detetar problemas de conteinerização.
  • A plataforma do sistema operacional Windows.

• Analise um diretório de código-fonte e mantenha as linhas de contexto detetadas com números de linha personalizados:

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

  A captura de tela a seguir mostra um exemplo de uso do --context-lines-number 3:

  

• Restrinja o conteúdo do relatório sem trechos de código:

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

  Quando --code-snips-number -1 é definido, os trechos de código não são exportados para o relatório. Esse comportamento ajuda a impedir que dados confidenciais sejam incluídos.

  

  Você também pode verificar a propriedade metadata.privacyMode em report.json.

  PrivacyMode valores:

  • Sem restrições – o relatório inclui trechos de código.
  • Restrito – o relatório não inclui trechos de código.

transformação de appcat

Converte regras XML do Windup em YAML.

Parâmetros necessários

Parâmetros globais

Exemplos

O exemplo a seguir converte uma regra XML de liquidação em YAML:

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

Versão do AppCat

Imprime a versão da ferramenta.

appcat version