mirror of
https://github.com/github/codeql.git
synced 2026-05-11 09:49:26 +02:00
56 lines
4.7 KiB
ReStructuredText
56 lines
4.7 KiB
ReStructuredText
:tocdepth: 1
|
|
|
|
.. _codeql-tools:
|
|
|
|
CodeQL tools
|
|
============
|
|
|
|
GitHub provides the CodeQL command-line interface and CodeQL for Visual Studio
|
|
Code for performing CodeQL analysis on open source codebases.
|
|
|
|
CodeQL command-line interface
|
|
-----------------------------
|
|
|
|
The CodeQL command-line interface (CLI) is primarily used to create databases for
|
|
security research. You can also query CodeQL databases directly from the command line
|
|
or using the Visual Studio Code extension.
|
|
It can be downloaded from `GitHub releases <https://github.com/github/codeql-cli-binaries/releases>`__.
|
|
For more information, see ":ref:`CodeQL CLI <codeql-cli>`" and the `CLI changelog <https://github.com/github/codeql-cli-binaries/blob/main/CHANGELOG.md>`__.
|
|
|
|
CodeQL packs
|
|
-----------------------------
|
|
|
|
The standard CodeQL query and library packs
|
|
(`source <https://github.com/github/codeql/tree/codeql-cli/latest>`__)
|
|
maintained by GitHub are:
|
|
- ``codeql/cpp-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/src>`__)
|
|
- ``codeql/cpp-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/cpp/ql/lib>`__)
|
|
- ``codeql/csharp-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/src>`__)
|
|
- ``codeql/csharp-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/csharp/ql/lib>`__)
|
|
- ``codeql/go-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/go/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/go/ql/src>`__)
|
|
- ``codeql/go-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/go/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/go/ql/lib>`__)
|
|
- ``codeql/java-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/java/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/java/ql/src>`__)
|
|
- ``codeql/java-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/java/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/java/ql/lib>`__)
|
|
- ``codeql/javascript-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/javascript/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/javascript/ql/src>`__)
|
|
- ``codeql/javascript-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/javascript/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/javascript/ql/lib>`__)
|
|
- ``codeql/python-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/python/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/python/ql/src>`__)
|
|
- ``codeql/python-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/python/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/python/ql/lib>`__)
|
|
- ``codeql/ruby-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/src>`__)
|
|
- ``codeql/ruby-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/ruby/ql/lib>`__)
|
|
|
|
For more information, see ":ref:`About CodeQL packs <about-codeql-packs>`."
|
|
|
|
CodeQL bundle
|
|
-----------------------------
|
|
|
|
The CodeQL bundle consists of the CodeQL CLI together with the standard CodeQL query and library packs
|
|
maintained by GitHub. It can be downloaded from `GitHub releases <https://github.com/github/codeql-action/releases>`__.
|
|
Use this when running `code scanning with CodeQL <https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql>`__ on GitHub Actions or in another CI system.
|
|
|
|
CodeQL for Visual Studio Code
|
|
-----------------------------
|
|
|
|
You can analyze CodeQL databases in Visual Studio Code using the CodeQL
|
|
extension, which provides an enhanced environment for writing and running custom
|
|
queries and viewing the results. For more information, see ":ref:`CodeQL
|
|
for Visual Studio Code <codeql-for-visual-studio-code>`." |