Skip to main content

Esta versão do GitHub Enterprise Server será descontinuada em 2026-03-17. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Manual de comandos da CLI do CodeQL

Informações de referência para os comandos disponíveis na versão mais recente da CodeQL CLI.

Quem pode usar esse recurso?

O CodeQL está disponível para os seguintes tipos de repositórios:

Observação

Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira http://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.

bqrs decode

Converta os dados de resultado do BQRS em outros formatos.

bqrs diff

Calcule a diferença entre dois conjuntos de resultados.

bqrs hash

[Conexão] Compute um hash estável de um arquivo BQRS.

informações sobre bqrs

Veja os metadados de um arquivo BQRS.

bqrs interpretar

[Conexão] Interprete os dados em um só BQRS.

Adicionar diagnóstico ao banco de dados

[Experimental] Adicionar uma informação de diagnóstico a um banco de dados.

análise de banco de dados

Analise um banco de dados, produzindo resultados significativos no contexto do código-fonte.

pacote de banco de dados

Crie um arquivo relocável de um banco de dados CodeQL.

limpeza do banco de dados

Compacte um banco de dados CodeQL em disco.

criação de banco de dados

Crie um banco de dados CodeQL para uma árvore de origem que possa ser analisada com um dos produtos do CodeQL.

Diagnóstico de exportação de banco de dados

[Experimental] Exporte informações de diagnóstico de um banco de dados para uma análise com falha.

finalização do banco de dados

[Conexão] Etapas finais na criação do banco de dados.

importação de dados

[Avançado] [Conexão] Importe os bancos de dados não finalizados para outro banco de dados não finalizado.

arquivos de índice de banco de dados

[Conexão] Indexe arquivos autônomos com um extrator do CodeQL especificado.

inicialização do banco de dados

[Conexão] Crie um banco de dados CodeQL vazio.

resultados da interpretação do banco de dados

[Conexão] Interprete os resultados da consulta computada em formatos significativos, como SARIF ou CSV.

linha de base de impressão do banco de dados

[Conexão] Imprima um resumo das linhas de código de linha de base vistas.

executar consultas no banco de dados

[Conexão] Execute um conjunto de consultas juntas.

comando de rastreamento de banco de dados

[Conexão] Execute um comando individual como parte de um build rastreado.

desagregação de banco de dados

Extrai um arquivo morto do banco de dados CodeQL.

atualização do banco de dados

Atualize um banco de dados para que ele possa ser utilizado pelas ferramentas atuais.

verificação do conjunto de dados

[Conexão] Verifique se há consistência interna em um conjunto de dados específico.

limpeza do conjunto de dados

[Conexão] Limpe arquivos temporários de um conjunto de dados.

importação de conjunto de dados

[Conexão] Importe um conjunto de arquivos TRAP para um conjunto de dados bruto.

métrica de conjunto de dados

[Conexão] Colete estatísticas sobre as relações em um conjunto de dados específico.

atualização do conjunto de dados

[Conexão] Atualize um conjunto de dados para que ele possa ser usado pelas ferramentas atuais.

adicionar diagnóstico

[Experimental] [Encanamento] Adicionar uma parte das informações de diagnóstico.

exportação de diagnóstico

[Experimental] Exportar informações de diagnóstico para uma análise com falha.

executar cli-server

[Conexão detalhada] Servidor para executar vários comandos, evitando a inicialização repetida de JVM.

executar o servidor de idiomas

[Conexão] Suporte online para a linguagem QL em IDEs.

executar consultas

[Conexão] Execute uma ou mais consultas em um conjunto de dados.

executar servidor de consultas

[Conexão] Suporte para execução de consultas em IDEs.

executar query-server2

[Conexão] Suporte para execução de consultas em IDEs.

executar atualizações

[Conexão] Execute scripts de atualização em um conjunto de dados QL bruto existente.

gerar metadados de predicados extensíveis

[Experimental] [Conexão detalhada] Relata os predicados extensíveis encontrados no pacote fornecido.

gerar resumo do log

[Avançado] Crie um resumo de um arquivo de log estruturado.

gerar alterações de sobreposição

[Canalização] Gerar um arquivo que pode ser usado para o

gerar consulta-ajuda

Gere a ajuda de consulta do usuário final por meio dos arquivos .qhelp.

resultados de mesclagem do GitHub

[Conexão profunda] Mescla vários arquivos SARIF em um único arquivo SARIF.

github upload-results

Carrega um arquivo SARIF na verificação de código do GitHub.

pack add

Adiciona uma lista de pacotes de biblioteca QL com intervalos de versão opcionais como dependências do pacote atual e os instala.

pacote combinado

[Conexão] Empacote um pacote de biblioteca QL.

pack ci

Instale dependências para esse pacote, verificando se o arquivo de bloqueio existente está atualizado.

criar pacote

[Conexão] Cria o conteúdo de um pacote QL a partir do código-fonte.

download do pacote

Baixe o conjunto de qlpacks referenciados pela especificação de consulta da linha de comando por meio do registro. Os pacotes podem ser fornecidos por nome ou implicitamente em um arquivo de pacote de consultas (.qls).

início do pacote

Inicializa um qlpack no diretório especificado.

instalação do pacote

Instale as dependências para este pacote.

pack ls

[Conexão detalhada] Liste os pacotes CodeQL com raiz neste diretório. Esse diretório precisa conter um arquivo qlpack.yml ou .codeqlmanifest.json.

pacote lista de pacotes

[Conexão] Compute o conjunto de arquivos a serem incluídos em um pacote de consultas QL ou um pacote de biblioteca.

publicação do pacote

Publica um pacote de biblioteca QL em um registro de pacote.

empacotar resolver-dependências

[Conexão] Compute o conjunto de dependências necessárias para este pacote QL.

atualização do pacote

Atualize as dependências desse pacote para as últimas versões disponíveis.

compilação de consulta

Compile ou verifique o código QL.

consulta descompilar

[Conexão] Leia uma representação intermediária de uma consulta compilada de um arquivo .qlo.

formato de consulta

Formate automaticamente o código-fonte QL.

execução de consulta

Execute uma consulta individual.

resolver banco de dados

[Conexão detalhada] Relate os metadados sobre o banco de dados.

resolver extensões

[Experimental] [Conexão detalhada] Determine as extensões acessíveis. Isso inclui os modelos de machine learning e as extensões de dados.

resolve extensões por pacote

[Experimental] [Conexão profunda] Determine extensões acessíveis para os caminhos fornecidos para empacotar raízes. Isso inclui os modelos de machine learning e as extensões de dados.

resolver problema do extrator

[Conexão detalhada] Determine o pacote de extrator a ser usado para determinada linguagem.

resolver arquivos

[Conexão detalhada] Expanda um conjunto de globs de inclusão/exclusão de arquivos.

resolver idiomas

Liste os pacotes de extratores do CodeQL instalados.

resolver o caminho da biblioteca

[Conexão detalhada] Determine o caminho da biblioteca QL e o dbscheme para uma consulta.

resolver metadados

[Conexão detalhada] Resolva e retorne os pares de metadados chave-valor de um arquivo de origem da consulta.

resolver modelos de aprendizado de máquina

[Preterido] [Experimental] [Conexão detalhada] Determine os modelos de machine learning acessíveis.

resolver pacotes

Exibir uma lista de pacotes do CodeQL disponíveis e seus locais.

resolver qlpacks

Crie uma lista de pacotes QL instalados e dos respectivos locais.

resolver qlref

[Conexão detalhada] Desreferencia um arquivo .qlref para retornar um .ql.

resolver consultas

[Conexão detalhada] Expanda os diretórios de consulta e as especificações de pacote.

solucionar problemas com a memória RAM

[Conexão detalhada] Prepare as opções de RAM.

resolver testes

[Conexão detalhada] Encontre testes de unidade de QL nos diretórios especificados.

resolver atualizações

[Conexão detalhada] Determine as atualizações a serem executadas para um conjunto de dados bruto.

aprovar teste

Aceite os resultados dos testes de unidade com falha.

extrato de teste

[Conexão] Crie um conjunto de dados para um diretório de teste.

execução de teste

Execute testes de unidade para consultas QL.

versão

Mostre a versão da cadeia de ferramentas do CodeQL.