Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Snyk provider docs #99

Merged
merged 1 commit into from
Dec 14, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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