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 --help
en el terminal.
Sinopsis
codeql pack add <options>... -- <scope/name[@range]>...
codeql pack add <options>... -- <scope/name[@range]>...
Descripción
Agrega una lista de paquetes de biblioteca QL con rangos de versiones opcionales como dependencias del paquete actual y, a continuación, los instala.
Este comando modifica el archivo qlpack.yml del paquete actual. Se quitarán el formato y los comentarios.
Disponible desde la versión v2.6.0
.
Opciones
Opciones principales
<scope/name[@range]>...
[Obligatorio] El ámbito, el nombre y el rango de versiones opcionales del paquete que se va a agregar a la lista de dependencias.
Si no se especifica ningún intervalo de versiones o si el intervalo de versiones se especifica como "latest", se descarga la versión más reciente del paquete y se agrega una dependencia al archivo qlpack.yml que permite cualquier versión compatible con la versión descargada.
Si se especifica una sola versión, se descarga esa versión del paquete y se agrega una dependencia al archivo qlpack.yml que permite cualquier versión compatible con la versión especificada.
Si se especifica un intervalo de versiones, se descarga la versión más reciente del paquete que satisface el intervalo especificado y se agrega una dependencia al archivo qlpack.yml con el intervalo de versiones especificado.
--dir=<dir>
Directorio raíz del paquete.
--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.
--[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
.
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
.