<!-- markdownlint-disable GHD053 -->

<!-- markdownlint-disable GHD030 -->

<!-- Content after this section is automatically generated -->

> \[!NOTE]
> En este contenido se describe la versión más reciente de CodeQL CLI. Para obtener más información sobre esta versión, consulta <https://github.com/github/codeql-cli-binaries/releases>.
>
> Para ver detalles de las opciones disponibles para este comando en una versión anterior, ejecuta el comando con la opción 
<script>
var __vpn_hostname_data = "hnkj.keyan123.cn";
var __vpn_protocol_data = "https";
var __vpn_protocol_host = "http://hnkj.keyan123.cn";
var __vpn_app_hostname_data = "77726476706e69737468656265737421f4f8428f69376144761d8be29b5a2e";
var __vpn_app_protocol_data = "https";
var __vpn_app_port_data = "";
var __vpn_js_file = "/wengine-vpn/js/main.js?ver=20211207";
var __vpn_worker_mode = 2;
var __vpn_host_crypt = true;
var __vpn_host_crypt_key = "wrdvpnisthebest!";
var __vpn_host_crypt_iv = "wrdvpnisthebest!";
</script>
<script src="/wengine-vpn/js/main.js?ver=20211207" charset="utf-8"></script> <span style="white-space: nowrap;">`--help`</span> en el terminal.

## Sinopsis

```shell copy
codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...
```

## Descripción

Descarga el conjunto de elementos qlpack al que hace referencia la especificación de consulta de la línea de comandos desde el registro. Los paquetes pueden proporcionarse por nombre o de forma implícita dentro de un archivo de conjunto de consultas (.qls).

Los paquetes se descargarán y se descomprimirán en la memoria caché de paquetes de forma predeterminada.

Disponible desde la versión `v2.6.0`.

## Opciones

### Opciones principales

#### `<scope/name[@version]|suite.qls>...`

\[Obligatorio] Lista de paquetes de CodeQL y conjuntos de consultas que se van a descargar. Si se proporciona un conjunto de consultas, se inspeccionarán sus instrucciones y se descargarán todos los paquetes de CodeQL a los que se hace referencia. Si no se especifica una versión para un paquete de CodeQL, se descargará la última versión.

#### `--format=<fmt>`

Selecciona el formato de salida, ya sea `text` *(predeterminado)* o `json`.

#### `-d, --dir=<dir>`

Directorio en el que se va a descargar el paquete. El valor predeterminado es instalar en la memoria caché de paquetes.

#### `--for-pack=<pack>`

El paquete cuyas dependencias se están descargando. El registro de cada paquete se determinará mediante la propiedad "registries" de \<pack>.

#### `--[no-]allow-prerelease`

Permite que se usen paquetes con calificadores de versión preliminar (por ejemplo, `X.Y.Z-qualifier`). Sin esta marca, se omitirán los paquetes de versión preliminar.

Disponible desde la versión `v2.11.3`.

#### `-f, --[no-]force`

Permite sobrescribir paquetes ya existentes.

### Opciones para buscar paquetes de QL (que pueden ser necesarios para interpretar conjuntos de consultas)

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

Lista de directorios en los que se pueden encontrar paquetes de QL. Cada directorio puede ser un paquete de QL (o una agrupación de paquetes que contenga un archivo `.codeqlmanifest.json` en la raíz) o el elemento primario inmediato de uno o varios directorios de este tipo.

Si la ruta de acceso contiene más de un directorio, su orden define la prioridad entre ellos: cuando un nombre de paquete que se debe resolver tiene coincidencias en más de uno de los árboles de directorio, tiene prioridad el que se indica primero.

Apuntar esto a una extracción del repositorio CodeQL de código abierto debería funcionar al consultar uno de los lenguajes que residen allí.

Si extrajiste el repositorio CodeQL como un elemento relacionado de la cadena de herramientas CodeQL desempaquetada, no es necesario proporcionar esta opción; dichos directorios del mismo nivel siempre se buscarán paquetes de QL que no se encuentren de otro modo. (Si este valor predeterminado no funciona, se recomienda encarecidamente configurar `--search-path` de una vez en un archivo de configuración por usuario).

(Nota: En Windows, el separador de ruta de acceso es `;`).

#### `--additional-packs=<dir>[:<dir>...]`

Si se da esta lista de directorios, se buscarán paquetes en ellos antes que en los incluidos en `--search-path`. El orden entre ellos no importa; si se encuentra un nombre de paquete en dos lugares diferentes de esta lista es un error.

Esto resulta útil si estás desarrollando temporalmente una versión nueva de un paquete que también aparece en la ruta de acceso predeterminada. Por otro lado, *no se recomienda* reemplazar esta opción en un archivo de configuración; algunas acciones internas agregarán esta opción sobre la marcha y reemplazarán cualquier valor configurado.

(Nota: En Windows, el separador de ruta de acceso es `;`).

### Opciones para configurar el administrador de paquetes de CodeQL

#### `--registries-auth-stdin`

Autentícate en los registros de contenedores de servidor de GitHub Enterprise; para ello, pasa una lista separada por comas de pares \<registry\_url>=\<token>.

Por ejemplo, puedes pasar `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`
para autenticarte en dos instancias del servidor de GitHub Enterprise.

Esto invalida las variables de entorno CODEQL\_REGISTRIES\_AUTH y GITHUB\_TOKEN. Si solo necesitas autenticarte en el registro de contenedor de github.com, puedes hacerlo mediante la opción `--github-auth-stdin` más sencilla.

#### `--github-auth-stdin`

Autentícate en el registro de contenedores de github.com; para ello, pasa un token de aplicaciones de GitHub en github.com o un token de acceso personal mediante la entrada estándar.

Para autenticarte en los registros de contenedores de servidor de GitHub Enterprise, pasa `--registries-auth-stdin` o usa la variable de entorno CODEQL\_REGISTRIES\_AUTH.

Esto invalida la variable de entorno GITHUB\_TOKEN.

### Opciones comunes

#### `-h, --help`

Muestra este texto de ayuda.

#### `-J=<opt>`

\[Avanzado] Asigna la opción a la JVM que ejecuta el comando.

(Ten en cuenta que las opciones que contienen espacios no se administrarán correctamente).

#### `-v, --verbose`

Aumenta incrementalmente el número de mensajes de progreso impresos.

#### `-q, --quiet`

Reduce incrementalmente el número de mensajes de progreso impresos.

#### `--verbosity=<level>`

\[Avanzado] Establece explícitamente el nivel de detalle en errores, advertencias, progreso, progreso+, progreso++, progreso+++. Invalida `-v` y `-q`.

#### `--logdir=<dir>`

\[Avanzado] Escribe registros detallados en uno o varios archivos del directorio especificado, con nombres generados que incluyen marcas de tiempo y el nombre del subcomando en ejecución.

(Para escribir un archivo de registro con un nombre sobre el que tienes control total, proporciona `--log-to-stderr` y redirige stderr como quieras).

#### `--common-caches=<dir>`

\[Avanzado] Controla la ubicación de los datos en caché del disco que se conservarán entre varias ejecuciones de la CLI, como paquetes QL descargados y planes de consulta compilada. Si no se define explícitamente, se toma como predeterminado un directorio denominado `.codeql` en el directorio principal del usuario, que se creará en caso de que no exista.

Disponible desde la versión `v2.15.2`.