Skip to content

Commit

Permalink
Fix docker example command (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
ypc-faros authored Mar 30, 2024
1 parent 5059c59 commit 9ffa25f
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,27 @@ $ ./bin/faros-scan-result-reporter /path/to/results.* \
```
Or with Docker:
```
# Run with docker (make sure to set ./path/to/results)
$ docker run -v "./path/to/results:/app/results" farosai/faros-scan-results-reporter:latest ./results/* \
# Run with docker (make sure to set /path/to/results)
# Example 1: Input file names are known
$ docker run -v "/path/to/results:/results" \
farosai/faros-scan-results-reporter:latest \
/results/example1.json /results/example2.json \
-k $FAROS_API_KEY \
--tool semgrep \
--repository '<repository>' \
--organization '<organization>' \
--source '<source>'
# Example 2: You want to use a wildcard to match multiple files
# Since wildcard expansion will not work as part of the `docker run` command, you can
# perform the expansion on the host:
$ docker run -v "/path/to/results:/results" \
farosai/faros-scan-results-reporter:latest \
$(for file in /path/to/results/*; do echo -n "/results/$(basename "$file") "; done) \
-k $FAROS_API_KEY \
--tool semgrep \
--repository '<repository>' \
Expand Down

0 comments on commit 9ffa25f

Please sign in to comment.