Skip to main content

execute language-server

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

Quem pode usar esse recurso?

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

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

Shell
codeql execute language-server --check-errors=<checkErrors> <options>...

Descrição

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

Esse comando só é relevante para autores de extensões de linguagem QL para IDEs. Ele é iniciado pela extensão do IDE em segundo plano e se comunica com ela por meio de um protocolo especial nos fluxos de entrada e de saída padrão.

Opções

Opções principais

--check-errors=<checkErrors>

[Obrigatório] Como verificar se há erros. Um destes: ON_CHANGE ou EXPLICIT.

--search-path=<dir>[:<dir>...]

Isso funciona como a opção semelhante à codeql query compile (q.v.).

Não há opções --additional-packs ou --library-path, pois os valores correspondentes são fornecidos online pela extensão do IDE por meio do protocolo do servidor de linguagem.

(Observação: no Windows, o separador de caminho é ;).

--synchronous

Execute ações em um só thread principal em vez de um executor encadeado.

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.