https://github.com/snyk-tech-services/snyk-disallow

Snyk Disallow tool for unwanted dependencies
https://github.com/snyk-tech-services/snyk-disallow

Last synced: about 1 month ago
JSON representation

Snyk Disallow tool for unwanted dependencies

• Host: GitHub
• URL: https://github.com/snyk-tech-services/snyk-disallow
• Owner: snyk-tech-services
• License: other
• Archived: true
• Created: 2020-06-02T23:27:19.000Z (about 4 years ago)
• Default Branch: develop
• Last Pushed: 2023-08-01T08:19:54.000Z (11 months ago)
• Last Synced: 2024-05-16T00:56:44.448Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 507 KB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-snyk-community - snyk-disallow - Create and manage a list of unwanted dependencies against which you can test your application with Snyk (Snyk CLI, Plugins, Extensions, Filters)

README

        
snyk-disallow

==============

Snyk Disallow tool

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/snyk-disallow.svg)](https://npmjs.org/package/snyk-disallow)

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

[![Downloads/week](https://img.shields.io/npm/dw/snyk-disallow.svg)](https://npmjs.org/package/snyk-disallow)

[![License](https://img.shields.io/npm/l/snyk-disallow.svg)](https://github.com/snyk-tech-services/snyk-disallow/blob/master/package.json)

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

⚠️ **This repository is now deprecated**

# Pre-requisites

- Paid plan.\

snyk-disallow uses Snyk APIs, only available in paid plans.

- Dep Graph API enabled for your account (contact us/your Customer Success Manager)

# Installation

```sh-session

$ npm install -g snyk-disallow

```

or 

[Download binary](https://github.com/snyk-tech-services/snyk-disallow/releases)

# Setup

- Create an org `Disallow` in your Snyk group.

- Have your Snyk CLI configured or export SNYK_TOKEN env var with your token (export SNYK_TOKEN=token / set SNYK_TOKEN=token)

# Usage

[![asciicast](https://storage.googleapis.com/snyk-technical-services.appspot.com/snyk-disallow-asciinema-poster.png)](https://asciinema.org/a/QWsTuNeUVf8dw5yn2DcpkArnf)

# Read-only usage

Get a viewer token for the Snyk Group to get a read|test-only token for CI or similar systems. (Ask your Customer Success Manager)

# Typical flow

- create disallow list for corresponding package manager

- add package name + version to the list of your choice

- check projects|org against disallow list(s)

## Commands

* `snyk-disallow help [COMMAND]`

* `snyk-disallow list`

* `snyk-disallow create [LISTNAME] [PACKAGEMANAGER]`

* `snyk-disallow add [DEP] [VERSION] [LISTNAME]`

* `snyk-disallow view [LISTNAME]`

* `snyk-disallow check-project [ORGID] [PROJECTID] [LISTNAME (optional)]`

* `snyk-disallow check-org [ORGID] [LISTNAME (optional)]`

* `snyk test --print-deps --json | snyk-disallow test-project [ORGID] [LISTNAME (optional)]`

* `snyk-disallow rm [DEP] [VERSION] [LISTNAME]`

* `snyk-disallow delete [LISTNAME]`