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
codeql pack add <options>... -- <scope/name[@range]>...
codeql pack add <options>... -- <scope/name[@range]>...
Descrição
[Experimental] Adiciona uma lista de pacotes de biblioteca QL com intervalos de versão opcionais como dependências do pacote atual e os instala.
Esse comando modifica o arquivo qlpack.yml do pacote atual. A formatação e os comentários serão removidos.
Disponível desde v2.6.0.
Opções
Opções primárias
<scope/name[@range]>...
[Obrigatório] O escopo, o nome e o intervalo de versão opcional do pacote a ser adicionado à lista de dependências.
Se nenhum intervalo de versão for especificado ou se o intervalo de versão for especificado como 'mais recente', a versão mais recente do pacote será baixada e uma dependência será adicionada a qlpack.yml que permite qualquer versão compatível com a versão baixada.
Se uma única versão for especificada, essa versão do pacote será baixada e uma dependência será adicionada ao qlpack.yml, que permite qualquer versão que seja compatível com a versão especificada.
Se um intervalo de versão for especificado, a versão mais recente do pacote que satisfaça o intervalo especificado será baixada e uma dependência será adicionada a qlpack.yml com o intervalo de versão especificado.
--dir=<dir>
O diretório raiz do pacote.
--registries-auth-stdin
Autentique-se nos registros de contêiner do GitHub Enterprise Server transmitindo uma lista separada por vírgula de pares <registry_url>=<token>.
Por exemplo, você pode transmitir https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
para se autenticar em duas instâncias do GitHub Enterprise Server.
Isso substitui as variáveis de ambiente CODEQL_REGISTRIES_AUTH e GITHUB_TOKEN. Se você só precisar se autenticar no registro de contêiner do github.com, poderá se autenticar usando a opção --github-auth-stdin mais simples.
--github-auth-stdin
Autentique-se no registro de contêiner do github.com transmitindo um token do GitHub Apps do github.com ou um token de acesso pessoal por meio da entrada padrão.
Para se autenticar nos registros de contêiner do GitHub Enterprise Server, transmita --registries-auth-stdin ou use a variável de ambiente CODEQL_REGISTRIES_AUTH.
Isso substitui a variável de ambiente GITHUB_TOKEN.
--[no-]allow-prerelease
Permita o uso de pacotes com qualificadores de versão de pré-lançamento (por exemplo, X.Y.Z-qualifier). Sem esse sinalizador, os pacotes de pré-lançamento serão ignorados.
Disponível desde v2.11.3.
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.