Skip to main content

Creating CodeQL CLI database bundles

Create a database bundle with CodeQL troubleshooting information.

¿Quién puede utilizar esta característica?

CodeQL está disponible para los siguientes tipos de repositorios:

Advertencia

Las agrupaciones de bases de datos de CodeQL CLI contienen una copia del código fuente que analiza CodeQL, por lo que se recomienda compartir estas agrupaciones solo con personas autorizadas para acceder a ese código fuente.

Nota:

En este artículo, se describen las características disponibles con el paquete CodeQL CLI 2.22.4 que se incluye en la versión inicial de GitHub Enterprise Server 3.19.

Si el administrador del sitio ha actualizado tu versión de la CodeQL CLI a una versión más reciente, consulta la versión de GitHub Enterprise Cloud de este artículo para obtener información sobre las características más recientes.

The following CodeQL CLI command syntax is suggested when creating a database bundle for troubleshooting purposes. This sample database bundle command requires CodeQL CLI version 2.17.6 or higher.

codeql database bundle --output=codeql-debug-artifacts.zip --include-diagnostics --include-logs --include-results -- <dir>

For this command, <dir> must be the path to the directory where the CodeQL database was created.

The successful command execution creates a zip file called codeql-debug-artifacts.zip which contains CodeQL troubleshooting information. That file is the database bundle.

This command assumes that the --log-dir command line argument was not used for the database create and database analyze commands. When that command line argument is used, the log files created by those commands will not be included with the database bundle.

Increasing the verbosity for database create and database analyze

If the database create and database analyze commands are not detailed enough for troubleshooting purposes, you can increase their verbosity.

Both commands support the --verbosity command line argument which can be set to progress++ prior to creating a database bundle.