Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2026-04-09. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

Scan from the command line

Run code scanning from the command line using the CodeQL CLI to configure scans, customize queries, and troubleshoot results.

Setting up the CodeQL CLI

To get started with the CodeQL CLI, you need to download and set up the CLI so that it can access the tools and libraries required to create and analyze databases.

Writing custom queries for the CodeQL CLI

You can write your own CodeQL queries to find specific vulnerabilities and errors.

Publishing and using CodeQL packs

Share or download a CodeQL pack, then analyze your CodeQL database.

Testing custom queries

Verify your custom CodeQL queries and catch breaking changes before they affect your code scanning results following new releases of the CodeQL CLI.

Testing query help files

Ensure your CodeQL query help files are valid by previewing them as Markdown.

Downloading CodeQL databases from GitHub

Expand the coverage of the CodeQL CLI by adding ready-made databases.

Checking out the CodeQL CLI source code

Set up the CodeQL CLI directly from the source code.

Specifying command options in a CodeQL configuration file

Save time by adding your frequently used command options and custom CodeQL packs to a CodeQL configuration file.

Creating CodeQL CLI database bundles

Create a database bundle with CodeQL troubleshooting information.