Skip to main content

Tool designed to add tags in bulk to Snyk projects

Project description

Snyk Tags Tool

Snyk Tags is a CLI tool with two purposes:

  • Help filter Snyk projects by product type by adding product tags across a Snyk Group or Organization - using snyk-tags tag
  • Help filter Snyk projects by applying tags to a collection of projects (for example a git repo like snyk-labs/nodejs-goof) - using snyk-tags collection

snyk-tags tag

snyk-tags tag is a CLI tool that uses the Snyk Project API to assign tags in bulk to Snyk projects based on the product type.

snyk-tags tag will update all projects of the specified product type within a Snyk Group or Organization with the product's tag.

You can also specify a custom tag for the products.

snyk-tags collection

snyk-tags collection uses the Snyk Project API to assign tags to all projects within a collection. A collection encompasses one or more projects in Snyk, for example:

  • snyk-labs/nodejs-goof is a collection from a git import
  • library/httpd is a collection from a container import
  • /snyk-labs/nodejs-goof is a collection from a CLI import

Once you run snyk-tags, go into the UI, naviagate to the projects page and find the tags filter options on the left-hand menu. Select the tag you have applied and you will visualize all projects associated.

Installation and requirements

Requirements

Requires Python version above 3.6

Installation

To install the simplest way is to use pip:

pip install snyk-tags

Alternatively you can clone the repo and then run the following commands:

poetry install # To install dependencies
python -m snyk-tags # To run snyk-tags

Examples

I want to filter all my Snyk Code projects to the whole Snyk Group:

snyk-tags tag sast --group-id=abc --token=abc

I want to filter all my npm Snyk Open Source projects within a specific Snyk Organization:

snyk-tags tag sca --scatype=npm --org-id=abc --token=abc

I want to filter all projects within my snyk-labs/nodejs-goof repo as project:snyk

snyk-tags collection apply --collectionname=snyk-labs/nodejs-goof --org-id=abc --token=abc --tagkey=project --tagvalue=snyk

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snyk-tags-0.3.0.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

snyk_tags-0.3.0-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page