safedep/vet
1
0
Fork 0
mirror of https://github.com/safedep/vet.git synced 2025-12-10 12:07:30 -06:00
Code Issues Packages Projects Releases 68 Wiki Activity

Add docker usage instructions in README

Browse Source
This commit is contained in:
abhisek 2023-03-23 17:20:18 +05:30
parent 3db93e9726
commit d63b920974
No known key found for this signature in database
GPG Key ID: CB92A4990C02A88F
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -22,6 +22,9 @@ manifests
vet scan -D /path/to/repo vet scan -D /path/to/repo
``` ```
> **Note:** An API key is required for `vet` to fetch package metadata. Refer
> [Getting Started](#getting-started) on how to obtain an API key.
![vet Summary Demo](docs/images/vet-summary-demo.png) ![vet Summary Demo](docs/images/vet-summary-demo.png)
[Example Security Gate](https://github.com/safedep/demo-client-java/pull/2) [Example Security Gate](https://github.com/safedep/demo-client-java/pull/2)
@ -29,9 +32,22 @@ using `vet` to prevent introducing new OSS dependency risk in an application.
## Getting Started ## Getting Started
> Ensure `$(go env GOPATH)/bin` is in your `$PATH` ### As Docker Container
Install using `go get` Run `vet` as a docker container without any installation
```bash
docker run --rm -it -v /path/to/your/source:/target \
-e VET_API_KEY=... \
ghcr.io/safedep/vet:latest \
scan -D /target
```
### Build from Source
To build from source, install using `go get`
> Ensure `$(go env GOPATH)/bin` is in your `$PATH`
```bash ```bash
go install github.com/safedep/vet@latest go install github.com/safedep/vet@latest
@ -41,6 +57,8 @@ Alternatively, look at [Releases](https://github.com/safedep/vet/releases) for
a pre-built binary for your platform. [SLSA Provenance](https://slsa.dev/provenance/v0.1) is published a pre-built binary for your platform. [SLSA Provenance](https://slsa.dev/provenance/v0.1) is published
along with each binary release. along with each binary release.
### Obtain API Key
Get an API key for [Insights API](https://safedep.io/docs/concepts/raya-data-platform-overview) access Get an API key for [Insights API](https://safedep.io/docs/concepts/raya-data-platform-overview) access
```bash ```bash
@ -197,6 +215,13 @@ Log to file:
vet scan -D /path/to/repo -l /tmp/vet.log -v vet scan -D /path/to/repo -l /tmp/vet.log -v
``` ```
### Which all ecosystems are supported?
* Java
* Go
* Javascript / NodeJS
* Python
## References ## References
* https://github.com/google/osv-scanner * https://github.com/google/osv-scanner