Skip to main content

Configurar o acesso à CLI do CodeQL

A extensão do CodeQL para Visual Studio Code usa a CodeQL CLI para compilar e executar consultas.

Configurar o acesso à CodeQL CLI

Se você já tiver a CodeQL CLI instalada e adicionada ao seu PATH, a extensão usará essa versão. Esse pode ser o caso se você criar seus próprios bancos de dados do CodeQL em vez de baixá-los do GitHub. Para obter mais informações, confira "Como preparar seu código para a análise do CodeQL".

Caso contrário, a extensão gerenciará automaticamente o acesso ao executável da CodeQL CLI para você. Isso garante que a CodeQL CLI seja compatível com a extensão do CodeQL. Você também pode verificar se há atualizações com o comando CodeQL: Check for CLI Updates no VS Code Command Palette.

Observações:

  • A extensão gerenciada da CodeQL CLI não está acessível no terminal. Se você pretende usar a CLI fora da extensão (por exemplo, para criar bancos de dados), recomendamos que você instale sua própria cópia da CodeQL CLI."

  • Para substituir o comportamento padrão e usar uma versão específica da CodeQL CLI, você pode especificar o Caminho Executável da CodeQL CLI nas configurações de extensão. Para obter mais informações, confira "Configurações personalizadas".

Solução de problemas

Se você tiver alguma dificuldade para configurar o acesso à CodeQL CLI, verifique o log de extensão do CodeQL para mensagens de erro ou para ver o local da CodeQL CLI que está sendo usado. Para obter mais informações, confira "Acessando os logs". Em particular, no log de extensão, você pode ver o local da CodeQL CLI que está sendo usado. Isso será útil se você quiser ver se essa é uma CLI gerenciada por extensão ou uma externa.

Se você usar a CodeQL CLI gerenciada por extensão, a extensão verificará se há atualizações automaticamente (ou com o comando CodeQL: Check for CLI Updates) e solicitará que você aceite a versão atualizada. Caso use uma CLI externa, você precisará atualizá-la manualmente (quando as atualizações forem necessárias).