You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-5Lines changed: 18 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,10 +67,11 @@ Here are some screenshots showcasing the extension's capabilities:
67
67
68
68
## 📋 Prerequisites
69
69
70
-
-**CodeQL CLI**: The extension requires the [CodeQL CLI](https://github.com/github/codeql-cli-binaries/releases) to be installed and available on your system PATH
71
-
- Download the latest release for your platform from the [CodeQL CLI releases page](https://github.com/github/codeql-cli-binaries/releases)
72
-
- Extract the archive and add the `codeql` binary to your system PATH
73
-
- Verify installation by running `codeql --version` in your terminal
70
+
-**CodeQL CLI**: The extension can automatically install the [CodeQL CLI](https://github.com/github/codeql-cli-binaries/releases) for you
71
+
- ✨ **Auto-Discovery**: The extension will automatically detect CodeQL CLI from GitHub's CodeQL extension if installed
72
+
- ✨ **Auto-Install**: If CodeQL CLI is not found, the extension will offer to download and install it automatically
73
+
-**Manual Install**: You can also download the latest release manually from the [CodeQL CLI releases page](https://github.com/github/codeql-cli-binaries/releases) and configure the path in settings
74
+
-**Verification**: Use `CodeQL: Show CLI Information` command to check your installation
74
75
75
76
-**GitHub Personal Access Token**: For GitHub integration features, a GitHub token with appropriate permissions is required
76
77
- Create a token at [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens)
@@ -89,6 +90,7 @@ Here are some screenshots showcasing the extension's capabilities:
89
90
|`CodeQL: Clear Logs`| Clear all log entries |
90
91
|`CodeQL: Clear Inline Diagnostics`| Remove inline problem markers |
91
92
|`CodeQL: Show CLI Information`| Display information about the CodeQL CLI |
-**`autoDetectGitHubExtension`** (default: `true`): Automatically detect and use CodeQL CLI from GitHub's CodeQL extension if available
114
+
-**`autoInstallCodeQL`** (default: `true`): Automatically download and install CodeQL CLI from GitHub if not found
115
+
-**`codeqlPath`**: Path to the CodeQL CLI executable (automatically configured when using auto-install)
116
+
-**`useLocalScan`** (default: `true`): Use local CodeQL CLI for scanning instead of GitHub Actions
117
+
105
118
## 💡 Why CodeQL Scanner?
106
119
107
120
CodeQL is GitHub's semantic code analysis engine that lets you query code as if it were data. This extension brings that power directly into VS Code, allowing you to:
0 commit comments