Note
Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://github.com/github/codeql-cli-binaries/releases.
Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção --help no terminal.
Sinopse
codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>
codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>
Descrição
[Experimental] Exporte informações de diagnóstico de um banco de dados para uma análise com falha.
Disponível desde v2.12.6.
Opções
Opções principais
<database>
[Obrigatório] Caminho para o banco de dados CodeQL em construção. Isso precisa ter sido preparado para extração com codeql database init.
Se a opção --db-cluster for fornecida, esse não será um banco de dados propriamente dito, mas um diretório que contém bancos de dados, e todos esses bancos de dados serão processados juntos.
--format=<format>
[Obrigatório] O formato no qual os resultados serão gravados. Um destes:
raw: uma lista de mensagens de diagnóstico brutas e não interpretadas como objetos JSON.
sarif-latest: SARIF (Static Analysis Results Interchange Format), um formato baseado em JSON usado para descrever os resultados da análise estática. Essa opção de formato usa a versão mais recente com suporte (v2.1.0). Essa opção não é adequada para uso na automação, pois produzirá diferentes versões do SARIF entre diferentes versões do CodeQL.
sarifv2.1.0: SARIF v2.1.0.
text: uma lista de marcadores de mensagens de diagnóstico.
--[no-]db-cluster
Indica que o diretório fornecido na linha de comando não é um banco de dados propriamente dito, mas um diretório que contém um ou mais bancos de dados em construção. Esses bancos de dados serão processados juntos.
-o, --output=<output>
O caminho de saída para o qual gravar informações de diagnóstico.
--sarif-exit-code=<sarifExitCode>
[Somente formatos SARIF] Código de saída do processo com falha.
--sarif-exit-code-description=<sarifExitCodeDescription>
[Somente formatos SARIF] Motivo pelo qual o processo com falha foi fechado.
--sarif-category=<category>
[Somente formatos SARIF] [Recomendado] Especifique uma categoria para essa análise incluir na saída SARIF. Uma categoria pode ser usada para distinguir várias análises executadas no mesmo commit e repositório, mas em diferentes linguagens ou partes do código.
Se você analisar a mesma versão de uma base de código de várias maneiras diferentes (por exemplo, para diferentes linguagens) e carregar os resultados no GitHub para apresentação na verificação de código, esse valor deverá ser diferente entre cada uma das análises, o que informa à verificação de código de que as análises suplementam umas às outras em vez de substituí-las. (Os valores devem ser consistentes entre as execuções da mesma análise para diferentes versões da base de código.)
Esse valor aparecerá (com uma barra à direita acrescentada se ainda não estiver presente) como a propriedade <run>.automationDetails.id.
Opções comuns
-h, --help
Mostre este texto de ajuda.
-J=<opt>
[Avançado] Forneça a opção para a JVM que executa o comando.
(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)
-v, --verbose
Aumente incrementalmente o número de mensagens de progresso impressas.
-q, --quiet
Diminua incrementalmente o número de mensagens de progresso impressas.
--verbosity=<level>
[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui -v e -q.
--logdir=<dir>
[Avançado] Escreva logs detalhados em um ou mais arquivos no diretório fornecido, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.
(Para gravar um arquivo de log com um nome sobre o qual você tem controle completo, forneça --log-to-stderr e redirecione stderr conforme desejado.)
--common-caches=<dir>
[Avançado] Controle a localização dos dados armazenados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilada. Se não for definido explicitamente, o padrão corresponde a um diretório intitulado .codeql no diretório inicial do usuário; que será criado se ainda não existir.
Disponível desde v2.15.2.