Esta versão do GitHub Enterprise Server foi descontinuada em 2024-09-25. 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.

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.

Quem pode usar esse recurso?

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

Neste artigo

Note

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 pack ls <options>... -- <dir>

Descrição

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

Disponível desde v2.7.1.

Opções

Opções principais

<dir>

O diretório raiz do pacote ou do workspace usa como padrão o diretório de trabalho atual. Se esse parâmetro apontar para um diretório que contenha um qlpack.yml, essa operação será executada somente nesse pacote CodeQL. Se esse parâmetro apontar para um diretório que contenha um codeql-workspace.yml, essa operação será executada em todos os pacotes CodeQL no workspace.

Opções para configurar os pacotes CodeQL aos quais esse comando será aplicado.

--format=<fmt>

Selecione o formato de saída: text (padrão) ou json.

--groups=[-]<group>[,[-]<group>...]

Lista de grupos de pacotes CodeQL a serem incluídos ou excluídos dessa operação. Um qlpack no workspace fornecido será incluído se:

  • Ele estiver em, pelo menos, um dos grupos listados sem um sinal de subtração (essa condição será atendida automaticamente se não houver grupos listados sem um sinal de subtração) e se
  • Ele não estiver em nenhum grupo listado com um sinal de subtração

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.