vet

command module
v0.0.3-dev Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 2, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

README

vet

vet is a tool for identifying risks in open source software supply chain. It helps engineering and security teams to identify potential issues in their open source dependencies and evaluate them against organizational policies.

TL;DR

Ensure $(go env GOPATH)/bin is in your $PATH

Install using go get

go install github.com/safedep/vet@latest

Alternatively, look at Releases for a pre-built binary for your platform.

Get a trial API key for Insights API access

vet auth trial --email john.doe@example.com

A time limited trial API key will be sent over email.

Configure vet to use API Key to access Insights API

vet auth configure

Insights API is used to enrich OSS packages with meta-data for rich query and policy decisions

Run vet to identify risks

vet scan -D /path/to/repository

or scan a specific (supported) package manifest

vet scan --lockfiles /path/to/pom.xml
vet scan --lockfiles /path/to/requirements.txt
vet scan --lockfiles /path/to/package-lock.json

The default scan uses an opinionated Console Reporter which presents a summary of findings per package manifest. Thats NOT about it. Read more for expression based filtering and policy evaluation.

Filtering

TODO

Policy Evaluation

TODO

FAQ

How do I disable the stupid banner?

Set environment variable VET_DISABLE_BANNER=1

References

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
gen
controlplane
Package controlplane provides primitives to interact with the openapi HTTP API.
Package controlplane provides primitives to interact with the openapi HTTP API.
insightapi
Package insightapi provides primitives to interact with the openapi HTTP API.
Package insightapi provides primitives to interact with the openapi HTTP API.
internal
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL