An open API service indexing awesome lists of open source software.

https://github.com/deviceinsight/vulnerability-scan


https://github.com/deviceinsight/vulnerability-scan

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Installation
```
yarn add @deviceinsight/vulnerability-scan --dev
npm install @deviceinsight/vulnerability-scan --save-dev
```

# Usage
```
scripts: {
"vulnerability-scan": "vulnerability-scan --config vulnerability-scan.json",
}
```

# Configuration

Vulnerability-scan uses [audit-ci](https://github.com/IBM/audit-ci) to provide the possibilitiy to set severity levels, advisory exclusions or even whitelists for moduless.

An error is returned if any results are found by the given configuration.

A config file can be passed by using the `--config ` flag.

The following configurations are possible:

```json
{
// [Optional] defaults `[]`
"advisories": ,
// [Optional] defaults `false`
"pretty-print": ,
// [Optional] defaults `undefined`
"registry": ,
// [Optional] defaults `high`
"severity": ,
// [Optional] defaults `[]`
"whitelist":
}
```