Skip to content

Commit

Permalink
feat: add Snyk provider docs (#99)
Browse files Browse the repository at this point in the history
* Adds Snyk provider documentation
  • Loading branch information
garethr committed Dec 14, 2022
1 parent 4747311 commit d1c36c6
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion doc/providers/snyk.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
![](../../img/providers/snyk.png)

# Snyk

Coming Soon
In order to use `bomber` with Snyk you will need to be a Snyk customer. Access requires your Snyk API Token, which you can retrieve from the web interface or by running:

```
snyk config get api
```

Once you have your token you can run bomber like so:

```
bomber scan --provider snyk --token xxx sbom.json
```

Note rather than passing the API token explicitly, you can also set this as an environment variable, either as `SNYK_TOKEN` or the generic `BOMBER_PROVIDER_TOKEN`.


## Supported ecosystems

At this time, the Snyk provider supports the following ecosystems:

* npm
* Maven
* CocoaPods
* Composer
* RubyGems
* Nuget
* PyPi
* Hex
* Cargo

0 comments on commit d1c36c6

Please sign in to comment.