Skip to content

Commit 37b0bbd

Browse files
committed
feat: Add prerequisites section to README for CodeQL CLI and GitHub token setup
1 parent e6c2370 commit 37b0bbd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,18 @@ Seamlessly integrate GitHub's powerful CodeQL scanning engine directly into your
3434
3. Open any code repository
3535
4. Run a scan using the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P`): `CodeQL: Run Scan`
3636

37+
## 📋 Prerequisites
38+
39+
- **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
40+
- Download the latest release for your platform from the [CodeQL CLI releases page](https://github.com/github/codeql-cli-binaries/releases)
41+
- Extract the archive and add the `codeql` binary to your system PATH
42+
- Verify installation by running `codeql --version` in your terminal
43+
44+
- **GitHub Personal Access Token**: For GitHub integration features, a GitHub token with appropriate permissions is required
45+
- Create a token at [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens)
46+
- Required permissions: `repo`, `read:org` (for organization repositories), `security_events` (for security alerts)
47+
- Store the token securely in your extension settings
48+
3749
## 📋 Available Commands
3850

3951
| Command | Description |

0 commit comments

Comments
 (0)