Tracking repositories and creating API keys

This article covers how to begin tracking repositories in Tidelift and generate repository-specific API keys from the Subscriber Dashboard. You can also read more about how to use the API to integrate into your workflow or jump straight into the Subscriber API documentation.

Tracking Repositories in Tidelift

Generally, you'll want to track each repository individually within Tidelift. Using the Tidelift web app, you can create a space to track each repository.

  1. From the Tidelift web app, select Repositories
  2. Select Track New Repository
  3. Name the repository you wish to track and Save
  4. If you are not planning to upload files manually, you can dismiss the prompt.

Generating API Keys

When integrating Tidelift into your workflow using our API, you will need to generate repository-specific API keys. If you are initially planning to manually upload dependency files, you can skip this step.

  1. From the Tidelift web app, select Settings > API Keys
  2. Select Create a New API Key.
  3. Find the repository for which you want to generate an API Key and select Create API Key
  4. You will then see your list of API keys and can access the Token and Authorization information for each Repository.

.tidelift files for CLI

Tidelift CLI supports configuring environment variables in a .tidelift file. You can download a preconfigured .tidelift file from the web app.

  1. From the Tidelift web app, select Settings > API Keys
  2. Find the API key for the repository or generate a new one
  3. Select Show token information
  4. Select Download .tidelift file
  5. Save this file in your repository's root directory

Be careful not to check the .tidelift file into any source control.

Note: If you are using Tidelift CLI in a CI/CD environment and cannot use a .tidelift file, you should configure the contents of a .tidelift file as environment variables (eg. export TIDELIFT_TEAM_NAME=example_team)

Troubleshooting note: Environment variables set in the command line will take precedence over a .tidelift file.

Still need help? Contact Us Contact Us