https://github.com/snyk-labs/snyk-filter

Snyk filtering for SNYK CLI
https://github.com/snyk-labs/snyk-filter

Last synced: 2 months ago
JSON representation

Snyk filtering for SNYK CLI

• Host: GitHub
• URL: https://github.com/snyk-labs/snyk-filter
• Owner: snyk-labs
• Created: 2018-03-22T00:37:53.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-15T23:05:06.000Z (9 months ago)
• Last Synced: 2024-05-19T06:16:25.304Z (9 months ago)
• Language: JavaScript
• Homepage: https://snyk.io
• Size: 473 KB
• Stars: 15
• Watchers: 7
• Forks: 26
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![Snyk logo](https://snyk.io/style/asset/logo/snyk-print.svg)](https://snyk.io)

***

# Custom Filtering for Snyk CLI

snyk-filter takes the JSON outputted from the [Snyk CLI](https://support.snyk.io/hc/en-us/articles/360003812578-CLI-reference), e.g. `snyk test --json` and applies custom filtering of the results, as well as options to fail your build.

[![Known Vulnerabilities](https://snyk.io//test/github/snyk-tech-services/snyk-filter/badge.svg?targetFile=package.json)](https://snyk.io//test/github/snyk-tech-services/snyk-filter?targetFile=package.json)

[![CircleCI](https://circleci.com/gh/snyk-tech-services/snyk-filter.svg?style=svg)](https://circleci.com/gh/snyk-tech-services/snyk-filter)

[![Inactively Maintained](https://img.shields.io/badge/Maintenance%20Level-Inactively%20Maintained-yellowgreen.svg)](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)

**This repository is in maintenance mode, no new features are being developed. Bug & security fixes will continue to be delivered. Open source contributions are welcome for small features & fixes (no breaking changes)**

# How do I use it?

## Install

`npm i -g snyk-filter`

### Note about `node-jq`

snyk-filter uses the `node-jq` library, which requires that a [`jq`](https://stedolan.github.io/jq/) binary is installed.  This typically happens transparently via `npm install -g`, but on some systems JQ does not get properly installed locally. If you receive an error after installation regarding `node-jq`, then `jq` should be installed manually to avoid this error.

```

# install jq ahead of time (ubuntu example)

sudo apt-get install -y jq

# tell node-jq to skip trying to install it on its own

export NODE_JQ_SKIP_INSTALL_BINARY=true

# tell node-jq where the existing jq binary is

export JQ_PATH=$(which jq)

# finally, install snyk-filter (does not work with node version > 12)

sudo npm install -g

```

## Usage

1. Implement your custom JQ filters in a .snyk-filter/snyk.yml file relative to your current working directory where you will be running snyk test from (see in [sample-filters](https://github.com/snyk-tech-services/snyk-filter/tree/develop/sample-filters) and tweak things from there - use [JQPlay](https://jqplay.org/) )

2. Then pipe your `snyk test --json` output into `snyk-filter` or use the `-i` argument to input a json file. Use the `-f` argument to point to the yml file containing your custom filters if you are not using the default location (.snyk-filter/snyk.yml).

3. Return code of snyk-filter will be 0 for pass (no issues) and 1 for fail (issues found)

### Example with Snyk CLI (using .snyk-filter/snyk.yml by default)

`snyk test --json | snyk-filter`

### Example with Snyk CLI and custom yml file location

`snyk test --json | snyk-filter -f /path/to/example-cvss-9-or-above.yml`

### Example

`snyk-filter -i snyk_results.json`

### Example with custom yml file location

`snyk-filter -i snyk_results.json -f /path/to/example-high-upgradeable-vulns.yml`

## Options

`--json` to output json

### License

[License: Apache License, Version 2.0](LICENSE)