Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

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.

O CodeQL do GitHub é licenciado por usuário após a instalação. Você pode usar o CodeQL somente para determinadas tarefas sob as restrições de licença. Para obter mais informações, confira "Sobre a CLI do CodeQL".

Se você tiver uma conta do GitHub Enterprise e uma licença do GitHub Advanced Security, poderá usar o CodeQL para análise automatizada, integração contínua e entrega contínua. Você pode criar uma conta corporativa entrando em contato com a equipe de vendas. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your 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

    [Plumbing] Compute a stable hash of a BQRS file.

  • bqrs info

    Display metadata for a BQRS file.

  • bqrs interpret

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

  • database add-diagnostic

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

  • database analyze

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

  • database bundle

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

  • database cleanup

    Compacte um banco de dados CodeQL em disco.

  • database create

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

  • database export-diagnostics

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

  • database finalize

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

  • database import

    [Advanced][Plumbing] Import unfinalized database(s) into another unfinalized database.

  • database index-files

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

  • database init

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

  • database interpret-results

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

  • database print-baseline

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

  • database run-queries

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

  • database trace-command

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

  • database unbundle

    Extrai um arquivo morto do banco de dados CodeQL.

  • database upgrade

    Upgrade a database so it is usable by the current tools.

  • dataset check

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

  • dataset cleanup

    [Plumbing] Clean up temporary files from a dataset.

  • dataset import

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

  • dataset measure

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

  • dataset upgrade

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

  • diagnostic add

    [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.

  • execute cli-server

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

  • execute language-server

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

  • execute queries

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

  • execute query-server

    [Plumbing] Support for running queries from IDEs.

  • execute query-server2

    [Plumbing] Support for running queries from IDEs.

  • execute upgrades

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

  • generate log-summary

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

  • generate query-help

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

  • github upload-results

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

  • pack add

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

  • pack bundle

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

  • pack ci

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

  • pack create

    [Experimental][Conexão] Cria o conteúdo de um pacote QL com base no código-fonte.

  • pack download

    [Experimental] 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).

  • pack init

    [Experimental] Inicializa um qlpack no diretório especificado.

  • pack install

    [Experimental] Instale as dependências deste pacote.

  • pack ls

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

  • pack packlist

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

  • pack publish

    [Experimental] Publica um pacote de biblioteca QL em um registro de pacote.

  • pack resolve-dependencies

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

  • pack upgrade

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

  • query compile

    Compile ou verifique o código QL.

  • query decompile

    [Plumbing] Read an intermediate representation of a compiled query from a .qlo file.

  • query format

    Formate automaticamente o código-fonte QL.

  • query run

    Execute uma consulta individual.

  • resolve database

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

  • resolve extensions

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

  • resolve extractor

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

  • resolve files

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

  • resolve languages

    Liste os pacotes de extratores do CodeQL instalados.

  • resolve library-path

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

  • resolve metadata

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

  • resolve ml-models

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

  • resolve qlpacks

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

  • resolve qlref

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

  • resolve queries

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

  • resolve ram

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

  • resolve tests

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

  • resolve upgrades

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

  • test accept

    Aceite os resultados dos testes de unidade com falha.

  • test extract

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

  • test run

    Execute testes de unidade para consultas QL.

  • version

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