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.

Sobre a CLI do CodeQL

Você pode usar os dados da CodeQL CLI para executar processos do CodeQL localmente em projetos de software.

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

Observação: este artigo foi migrado do site de documentação do CodeQL em janeiro de 2023.

Sobre a CodeQL CLI

Desenvolvedores de software e pesquisadores de segurança podem proteger o código usando a CodeQL CLI.

A CodeQL CLI é uma ferramenta de linha de comando usada para executar processos do CodeQL localmente em projetos de software de código aberto. Você pode usar a CodeQL CLI para:

  • Executar análises do CodeQL usando consultas fornecidas por engenheiros do GitHub e pela comunidade de código aberto
  • Criar bancos de dados do CodeQL a serem usados no CodeQL para Visual Studio Code
  • Desenvolver e testar consultas personalizadas do CodeQL a serem usadas em suas análises

Para obter informações de como usar a CodeQL CLI, confira "Introdução à CodeQL CLI".

Sobre a licença do GitHub CodeQL

Aviso de licença: se você não tiver uma licença do GitHub Enterprise, baixando este arquivo, você estará concordando com os Termos e condições do GitHub CodeQL.

O GitHub CodeQL é licenciado por usuário. Sob as restrições de licença, você pode usar o CodeQL para executar as seguintes tarefas:

  • Realizar pesquisas acadêmicas.
  • Demonstrar o software.
  • Testar consultas do CodeQL lançadas sob uma licença aprovada pela OSI para confirmar que novas versões dessas consultas continuam a encontrar as vulnerabilidades certas.

Em que "Licença aprovada pela OSI" significa uma licença de software de código aberto aprovada pela OSI (Open Source Initiative).

Se você estiver trabalhando com uma base de código Open Source Codebase (ou seja, uma base de código lançada sob uma licença aprovada pela OSI), também poderá usar o CodeQL para as seguintes tarefas:

  • Executar a análise da Open Source Codebase.
  • Gerar bancos de dados do CodeQL voltados à análise automatizada, integração contínua ou entrega contínua, quando a Open Source Codebase for hospedada e mantida no GitHub.com.

O CodeQL não pode ser usado para análise automatizada, integração contínua ou entrega contínua, seja nos processos normais de engenharia de software ou de outra forma, exceto nos casos expressos estabelecidos aqui. Para esses usos, entre em contato com a equipe de vendas.

Comandos da CodeQL CLI

A CodeQL CLI inclui comandos para criar e analisar bancos de dados do CodeQL usando a linha de comando. Para executar um comando, use:

codeql [command] [subcommand]

Para exibir a documentação de referência de um comando, adicione o sinalizador --help ou visite o "manual da CodeQL CLI".