Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
expanded README to cover CLI options/flags
Browse files Browse the repository at this point in the history
  • Loading branch information
Igor Shmukler committed Oct 7, 2018
1 parent b551b2f commit bf4d48b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,23 @@ Gammaray comes as a single binary so you only need to run it passing your projec
$> gammaray <path-to-your-node-app>
```

Gammaray supports the following flags:

`-path` - path to directory where package.json is located

`-image` - docker image to scan

`-log-level` - valid values: `panic` | `fatal` | `error` | `warn` | `info` | `debug`. The default is `info`.

`-ignore-list` - path to JSON file with CVE/CWE ignore array
The sample file is shown below:
```
[
{"CVE": "CWE-400", "description": "We ignore this because it does not affect us"},
{"CVE": "CVE-2015-8851", "description": "We ignore this because it does not affect us"}
]
```

And that is all, all the vulnerabilities that affect your packages will be displayed.

## Contributing
Expand Down

0 comments on commit bf4d48b

Please sign in to comment.