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
codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...
codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...
Descrição
Baixe o conjunto de qlpacks referenciados pela especificação de consulta da linha de comando por meio do registro. Os pacotes podem ser fornecidos por nome ou implicitamente em um arquivo de pacote de consultas (.qls).
Os pacotes serão baixados e descompactados no cache de pacotes por padrão.
Disponível desde v2.6.0.
Opções
Opções principais
<scope/name[@version]|suite.qls>...
[Obrigatório] Lista de pacotes CodeQL e pacotes de consultas a serem baixados. Se um pacote de consultas for fornecido, as instruções serão inspecionadas e todos os pacotes CodeQL referenciados serão baixados. Se você não especificar uma versão para um pacote CodeQL, a última versão será baixada.
--format=<fmt>
Selecione o formato de saída: text (padrão) ou json.
-d, --dir=<dir>
O diretório no qual o pacote será baixado. Usa como padrão a instalação no cache de pacotes.
--for-pack=<pack>
O pacote cujas dependências estão sendo baixadas. O registro de cada pacote será determinado pela propriedade 'registries' de <pack>.
--[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.
-f, --[no-]force
Permita a substituição dos pacotes já existentes.
Opções para localizar pacotes QL (que podem ser necessários para interpretar conjuntos de consultas)
--search-path=<dir>[:<dir>...]
Uma lista de diretórios nos quais os pacotes QL podem ser encontrados. Cada diretório pode ser um pacote QL (ou um conjunto de pacotes que contém um arquivo .codeqlmanifest.json na raiz) ou o pai imediato de um ou mais desses diretórios.
Se o caminho contiver mais de um diretório, a ordem deles definirá a precedência entre eles: quando for encontrada uma correspondência do nome de um pacote que precisa ser resolvido em mais de uma das árvores do diretório, a primeira fornecida vencerá.
Se você apontar isso para um check-out do repositório do CodeQL de código aberto, isso deverá funcionar durante a consulta de uma das linguagens que se encontram nele.
Se você tiver feito check-out do repositório do CodeQL como um irmão da cadeia de ferramentas CodeQL descompactada, não precisará fornecer essa opção. Nesses diretórios irmãos, sempre será feita a pesquisa por pacotes QL que não podem ser encontrados de outra forma. (Caso esse padrão não funcione, recomendamos fortemente configurar --search-path de uma vez por todas em um arquivo de configuração por usuário).
(Observação: no Windows, o separador de caminho é ;).
--additional-packs=<dir>[:<dir>...]
Se essa lista de diretórios for fornecida, nesses diretórios, será feita a pesquisa de pacotes antes daqueles contidos em --search-path. A ordem entre eles não importa: será indicado um erro se o nome de um pacote for encontrado em dois locais diferentes nessa lista.
Isso será útil se você estiver desenvolvendo temporariamente uma nova