Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nealfennimore/codeql-docker
CodeQL Docker wrapper
https://github.com/nealfennimore/codeql-docker
codeql codeql-cli codeql-command codeql-container codeql-docker
Last synced: 6 days ago
JSON representation
CodeQL Docker wrapper
- Host: GitHub
- URL: https://github.com/nealfennimore/codeql-docker
- Owner: nealfennimore
- Created: 2021-03-08T01:46:26.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T18:04:03.000Z (2 months ago)
- Last Synced: 2024-11-14T21:15:26.976Z (2 months ago)
- Topics: codeql, codeql-cli, codeql-command, codeql-container, codeql-docker
- Language: Dockerfile
- Homepage:
- Size: 53.7 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docker CodeQL
Versioned [CodeQL](https://github.com/github/codeql) and [CodeQL CLI](https://github.com/github/codeql-cli-binaries) container.
See [CodeQL CLI Manual](https://codeql.github.com/docs/codeql-cli/manual/) for commands.
## Installation
```sh
# Using uncompiled base
docker pull ghcr.io/nealfennimore/codeql:latest# Using compiled language (cpp, csharp, csv, go, html, java, javascript, properties, python, xml supported)
docker pull ghcr.io/nealfennimore/codeql:javascript
docker pull ghcr.io/nealfennimore/codeql:go
docker pull ghcr.io/nealfennimore/codeql:cpp
```### Building Locally
If you prefer to build locally instead of using a precompiled image
```sh
docker build . \
--build-arg CLI_VERSION=2.7.0 \
--build-arg CODE_LANGUAGE=$CODE_LANGUAGE \
--tag ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE
```
## Usage### Shell
To drop to shell to work with codeql directly
```sh
docker run --rm -it \
-v ~/code/db:/tmp/db \
-v ~/code/src:/tmp/src \
-v ~/code/output:/tmp/output \
ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE bash# Then proceed to create database for the language:
codeql database create --language=$CODE_LANGUAGE --source-root /tmp/src /tmp/db# Analyze source code and generate report:
codeql database analyze /tmp/db $CODE_LANGUAGE-lgtm.qls --format=sarif-latest --output=/tmp/output/results.sarif
```### Database
#### Creation
```sh
docker run --rm -it \
-v ~/code/db:/tmp/db \
-v ~/code/src:/tmp/src \
ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE \
codeql database create --language=$CODE_LANGUAGE --source-root /tmp/src /tmp/db
```#### Analyzing Source Code
```sh
docker run --rm -it \
-v ~/code/db:/tmp/db \
-v ~/code/src:/tmp/src \
-v ~/code/output:/tmp/output \
ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE \
codeql database analyze /tmp/db $CODE_LANGUAGE-lgtm.qls \ # Analyze with default query suites
--format=sarif-latest \
--output=/tmp/output/results.sarif
```