safedep/vet
1
0
Fork 0
mirror of https://github.com/safedep/vet.git synced 2025-12-10 00:22:08 -06:00
Code Issues Packages Projects Releases 68 Wiki Activity
vet/docs/docs/quick-start.md
Madhu Akula bf2dbe0f1b
Added vet documentation
2023-03-29 00:56:52 +02:00

1.2 KiB
Raw Blame History

sidebar_position, title
sidebar_position title
2 🚀 Quick Start

🚀 Quick Start

vet Github Releases

  • Get an API key for the vet insights data access for performing the scan
vet auth trial --email john.doe@example.com

vet register trial

:::info

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

:::

  • Configure vet to use API key to access the insights
vet auth configure

vet configure

:::tip

Insights API is used to enrich OSS packages with metadata for rich query and policy decisions. Alternatively, the API key can be passed through environment variable VET_API_KEY

:::

  • Run vet to identify risks
vet scan -D /path/to/repository

vet scan directory

  • You can also 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

vet scan files