Files
codeql/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst
2023-02-03 13:37:53 -05:00

25 lines
2.8 KiB
ReStructuredText

.. _getting-started-with-the-codeql-cli:
Getting started with the CodeQL CLI
===================================
.. pull-quote::
This article was moved to "`Getting started with the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
* `Setting up the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#setting-up-the-codeql-cli>`__
* `1. Download the CodeQL CLI zip package <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#1-download-the-codeql-cli-zip-package>`__
* `2. Extract the zip archive <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#2-extract-the-zip-archive>`__
* `3. Launch codeql <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#3-launch-codeql>`__
* `4. Verify your CodeQL CLI setup <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#4-verify-your-codeql-cli-setup>`__
* `Checking out the CodeQL source code directly <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#checking-out-the-codeql-source-code-directly>`__
* `1. Download the CodeQL CLI zip <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#1-download-the-codeql-cli-zip>`__
* `2. Create a new CodeQL directory <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#2-create-a-new-codeql-directory>`__
* `3. Obtain a local copy of the CodeQL queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#3-obtain-a-local-copy-of-the-codeql-queries>`__
* `4. Extract the zip archive <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#4-extract-the-zip-archive>`__
* `5. Launch codeql <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#5-launch-codeql>`__
* `6. Verify your CodeQL CLI setup <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#6-verify-your-codeql-cli-setup>`__
* `Using two versions of the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#using-two-versions-of-the-codeql-cli>`__