En este contenido se describe la versión más reciente de la CLI de CodeQL. 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 ls <options>... -- <dir>
Descripción
[Experimental] [Asociación profunda] Enumera los paquetes de CodeQL con raíz en este directorio. Este directorio debe contener un archivo qlpack.yml o .codeqlmanifest.json.
Disponible desde la versión v2.7.1
.
Opciones principales
<dir>
El directorio raíz del paquete o del área de trabajo tiene como valor predeterminado el directorio de trabajo actual. Si este parámetro apunta a un directorio que contiene un elemento qlpack.yml, esta operación solo se ejecutará en ese paquete de CodeQL. Si este parámetro apunta a un directorio que contiene un elemento codeql-workspace.yml, esta operación se ejecutará en todos los paquetes de CodeQL del área de trabajo.
Opciones para configurar los paquetes de CodeQL a los que se va a aplicar este comando.
--format=<fmt>
Selecciona el formato de salida, ya sea text
(valor predeterminado) o json
.
--groups=[-]<group>[,[-]<group>...]
Lista de grupos de paquetes de CodeQL que se van a incluir o excluir de esta operación. Se incluye un objeto qlpack en el área de trabajo especificada si:
- Está en al menos uno de los grupos enumerados sin un signo menos (esta condición se cumple automáticamente si no hay grupos enumerados sin el signo menos) y
- No está en ningún grupo enumerado con un signo menos
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).