Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 3.6 KB

installing-codeql-for-vs-code.md

File metadata and controls

66 lines (41 loc) · 3.6 KB
title shortTitle versions product topics type intro allowTitleToDifferFromFilename
Installing CodeQL for Visual Studio Code
Extension installation
fpt ghec ghes
*
*
*
{% data reusables.gated-features.codeql %}
Code Security
Code scanning
CodeQL
reference
To get started with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, you need to install and set up the extension.
true

Prerequisites

The {% data variables.product.prodname_codeql %} extension requires a minimum of {% data variables.product.prodname_vscode %} 1.82.0. Older versions are not supported.

Installing the extension

You can install the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension using one of several different methods:

  • Using the {% data variables.product.prodname_vscode %} Marketplace in a browser.

  • Searching in the "Extensions" view in {% data variables.product.prodname_vscode %}.

  • Using a VSIX file.

Using the {% data variables.product.prodname_vscode %} Marketplace

  1. In your browser, go to the "{% data variables.product.prodname_codeql %}" page in the {% data variables.product.prodname_vscode %} Marketplace.

  2. Click Install, then follow the on-screen prompts.

Searching in the "Extensions" view

  1. In {% data variables.product.prodname_vscode_shortname %}, open the "Extensions" view.

  2. Search for "{% data variables.product.prodname_codeql %}", then click Install.

Using the {% data variables.product.prodname_codeql %} VSIX file

  1. Download the {% data variables.product.prodname_codeql %} VSIX file from the github/vscode-codeql repository on {% data variables.product.prodname_dotcom %}.

  2. In {% data variables.product.prodname_vscode_shortname %}, open the "Extensions" view.

  3. At the top right of the sidebar, click the ellipsis then click Install from VSIX....

  4. Select the {% data variables.product.prodname_codeql %} VSIX file downloaded in step 1.

  5. Follow the on-screen prompts to complete the installation.

Next steps

To learn how to work with {% data variables.product.prodname_codeql %} databases in the extension, see AUTOTITLE.

If you have already found, downloaded, or created a {% data variables.product.prodname_codeql %} database, you can learn how to use the extension to run queries on {% data variables.product.prodname_codeql %} databases and view the results. For more information, see AUTOTITLE.

To learn how to model additional dependencies of a codebase and improve your {% data variables.product.prodname_code_scanning %} results, see AUTOTITLE.

To learn how to configure access to a different version of the {% data variables.product.prodname_codeql_cli %} than the one installed with the extension, see AUTOTITLE.

To learn how to set up a {% data variables.product.prodname_codeql %} workspace, see AUTOTITLE.