Skip to main content

Creating CodeQL CLI database bundles

You can create a database bundle with CodeQL troubleshooting information.

谁可以使用此功能?

CodeQL 可用于以下存储库类型:

Warning

CodeQL CLI database bundles contain a copy of the source code being analyzed by CodeQL, therefore we suggest sharing these bundles only with people who are authorized to access that source code.

About creating CodeQL CLI database bundles

Note

本文介绍了 GitHub Enterprise Server 3.15 的初始发行版中包含的 CodeQL CLI 2.20.3 捆绑包中可用的功能。

如果站点管理员已将 CodeQL CLI 版本更新为较新版本,请参阅本文的 GitHub Enterprise Cloud 版本,了解有关最新功能的信息。

The CodeQL CLI database bundle command can be used to create a relocatable archive of a CodeQL database.

A copy of a database bundle can be used to share troubleshooting information with your team members or with GitHub 支持.

The following CodeQL CLI command syntax is suggested when creating a database bundle for troubleshooting purposes:

Note

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.