SupportSnyk LearnAPI referenceProduct updatesSign up for free
Edit

snyk-scm-contributors-count

What does this tool do?

This tool counts and prints a summary of the contributors count for the last 90 days for any of the following SCMs:

  • Azure Devops

  • Bitbucket Cloud

  • Bitbucket Server

  • GitHub

  • GitHub Enterprise

  • GitLab

  • GitLab Server

There are some minor differences between the SCMs as to the naming convention. For example: "Orgs" in GitHub can be "Projects" in Azure and "Workspaces" in Bitbucket. These differences are reflected in the commands that the tool accepts for each SCM.

Prerequisites

Complete the following prerequisites before running the script:

  1. Export the Snyk API token. You can find the token in the Snyk Web UI under the account Settings.

  2. Ensure the SCM Personal Access Token (PAT) has Code/Read permissions. Snyk recommends full access.

  3. Verify you have access to all in-scope SCM Organizations and Projects.

  4. Use npx for one-off executions to avoid installing the script globally.

For more information, see the tool repository README.

How the SCM-Contributors-Count tool works

The tool works in two modes: Scoping usage prior to onboarding and Snyk License Consumption.

  • Scoping usage prior to onboarding: For users who want to onboard to Snyk and would like to get an estimate of the developer count across their SCMs. In this mode, the tool fetches all the information directly from the SCMs, using the credentials provided by the user.

  • Snyk License Consumption (valid only for Bitbucket and Azure): For users with an existing Snyk account, who want some clarity and details about their license consumption (number of contributors, names, email, and so on). In this mode, the tool fetches the SCM-related projects monitored by Snyk and then matches those to the repos on the SCM and counts the contributors only for those repos/projects.

Note that currently the tool does not count emails that end with "noreply.github.com".

Downloading the tool

Run the following:

You can also get the binaries from the release page.

Previoussnyk-to-htmlNextFlowchart

Last updated

Was this helpful?