Skip to content

Commit d068abd

Browse files
[EDI] Configuring access to the CodeQL CLI (#59728)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent 7078989 commit d068abd

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Configuring access to the CodeQL CLI
2+
title: Managing the CodeQL CLI in the VS Code extension
33
shortTitle: CodeQL CLI access
44
versions:
55
fpt: '*'
@@ -16,18 +16,20 @@ redirect_from:
1616
contentType: how-tos
1717
---
1818

19-
## Configuring access to the {% data variables.product.prodname_codeql_cli %}
19+
The {% data variables.product.prodname_codeql %} extension automatically installs a compatible version of the {% data variables.product.prodname_codeql_cli %}. This instance of the {% data variables.product.prodname_codeql_cli %} is not accessible from the terminal.
2020

21-
If you already have the {% data variables.product.prodname_codeql_cli %} installed and added to your `PATH`, the extension will use that version. This might be the case if you create your own {% data variables.product.prodname_codeql %} databases instead of downloading them from {% data variables.product.github %}. For more information, see [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis).
21+
If you already have the {% data variables.product.prodname_codeql_cli %} installed and added to your `PATH`, the extension will use that version.
2222

23-
Otherwise, the extension automatically manages access to the executable of the {% data variables.product.prodname_codeql_cli %} for you. This ensures that the {% data variables.product.prodname_codeql_cli %} is compatible with the {% data variables.product.prodname_codeql %} extension. You can also check for updates with the **{% data variables.product.prodname_codeql %}: Check for CLI Updates** command from the {% data variables.product.prodname_vscode_command_palette_shortname %}.
23+
## Installing version updates
2424

25-
> [!NOTE]
26-
> * The extension-managed {% data variables.product.prodname_codeql_cli %} is not accessible from the terminal. If you intend to use the CLI outside of the extension (for example to create databases), we recommend that you install your own copy of the {% data variables.product.prodname_codeql_cli %}."
27-
> * To override the default behavior and use a specific version of the {% data variables.product.prodname_codeql_cli %}, you can specify the {% data variables.product.prodname_codeql_cli %} **Executable Path** in the extension settings. For more information, see [AUTOTITLE](/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings).
25+
The extension checks for updates to the {% data variables.product.prodname_codeql_cli %} automatically and prompts you to accept the updated version.
2826

29-
## Troubleshooting
27+
You can check for updates manually with the **{% data variables.product.prodname_codeql %}: Check for CLI Updates** command from the {% data variables.product.prodname_vscode_command_palette_shortname %}.
28+
29+
## Using a different {% data variables.product.prodname_codeql_cli %} installation
3030

31-
If you have any difficulty setting up access to the {% data variables.product.prodname_codeql_cli %}, check the {% data variables.product.prodname_codeql %} Extension log for error messages or to see the location of the {% data variables.product.prodname_codeql_cli %} being used. For more information, see [AUTOTITLE](/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/accessing-logs). In particular, in the Extension log you can see the location of the {% data variables.product.prodname_codeql_cli %} that is being used. This is useful if you want to see whether this is an extension-managed CLI or an external one.
31+
To override the default behavior and use a specific version of the {% data variables.product.prodname_codeql_cli %}, you can specify the {% data variables.product.prodname_codeql_cli %} **Executable Path** in the extension settings. See [AUTOTITLE](/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings).
32+
33+
## Troubleshooting
3234

33-
If you use the extension-managed {% data variables.product.prodname_codeql_cli %}, the extension checks for updates automatically (or with the **{% data variables.product.prodname_codeql %}: Check for CLI Updates** command) and prompts you to accept the updated version. If you use an external CLI, you need to update it manually (when updates are necessary).
35+
You can check the {% data variables.product.prodname_codeql %} Extension log for error messages or to see the location of the {% data variables.product.prodname_codeql_cli %} being used. See [AUTOTITLE](/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/accessing-logs).

0 commit comments

Comments
 (0)