Getting started with the CodeQL CLI
You can use the CodeQL CLI to locally develop, test and run CodeQL queries on software projects.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, see GitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Enterprise Cloud with GitHub Advanced Security enabled
About the CodeQL CLI
You can use the CodeQL CLI to run CodeQL processes locally on software projects or to generate code scanning results for upload to GitHub.
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.
Preparing your code for CodeQL analysis
You can build a CodeQL database containing the data needed to analyze your code.
Analyzing your code with CodeQL queries
You can run queries against a CodeQL database extracted from a codebase.
Uploading CodeQL analysis results to GitHub
You can use the CodeQL CLI to upload CodeQL analysis results to GitHub.
Customizing analysis with CodeQL packs
You can use CodeQL packs to run CodeQL queries maintained by other people, or to share CodeQL queries that you've developed.