Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/advanced-security/gh-codeql-scan
GH CLI CodeQL Scan Extension
https://github.com/advanced-security/gh-codeql-scan
Last synced: 3 months ago
JSON representation
GH CLI CodeQL Scan Extension
- Host: GitHub
- URL: https://github.com/advanced-security/gh-codeql-scan
- Owner: advanced-security
- License: mit
- Created: 2022-08-09T16:48:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T14:50:23.000Z (about 1 year ago)
- Last Synced: 2024-04-14T11:43:01.429Z (7 months ago)
- Language: Shell
- Size: 37.1 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-codeql - gh-codeql-scan - GH CLI CodeQL Scan Extension (CodeQL CLI Tooling)
README
# gh-codeql-scan
GitHub CLI CodeQL Scan Extension to help abstract CodeQL away from users.
## Requirements
- [GitHub CLI](https://cli.github.com/)
## Install and Setup
This installs CodeQL and this scan tool:
```bash
gh extensions install github/gh-codeql
gh extensions install advanced-security/gh-codeql-scan
gh codeql-scan --help
```
A couple of tips and tricks:
```
# Create an alias to make things even easier
alias codeql-scan="gh codeql-scan"
```
## Usage
The main use of the script is to automatically run CodeQL in a number of modes.
```bash
# End-to-end analysis and upload results
gh codeql-scan
```
```bash
# `init` mode: Create only the Codeql database
gh codeql-scan init --auto-detect
# or manually set language
gh codeql-scan init -l=java
```
```bash
# Compiled languages - pass in build command
gh codeql-scan -c "mvn build ..."
```
```bash
# Compiled languages - complicated build process using indirect build tracing
gh codeql-scan init
echo "password=$password" > settings.xml
mvn build --random-custom=flags
gh codeql-scan analyze
```
```bash
# `analyze` mode: Run query-suites on an existing database (auto-detects databases)
gh codeql-scan analyze
```
```bash
# `upload` mode: Upload all SARIF files
gh codeql-scan upload
```
## License
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.md) for the full terms.
## Maintainers
- @GeekMasher
## Support
Support is via [GitHub Issues](https://github.com/advanced-security/gh-codeql-scan/issues)
## Acknowledgement