Installing the Tidelift CLI

The Tidelift command line interface ( Tidelift CLI) provides an alternate way to initiate scans of a project and check the alignment of a project with your organization's catalog of approved open-source packages.

Install instructions

Note: A Tidelift account is needed to use Tidelift CLI.

1. Install the CLI tool into your user's binary directory ( we suggest a ~/bin on Mac & Linux) using the curl command below for your OS.

  • Linux: curl https://download.tidelift.com/cli/tidelift -o ~/bin/tidelift
  • MacOS: curl https://download.tidelift.com/cli/tidelift_darwin -o ~/bin/tidelift
  • Windows: curl https://download.tidelift.com/cli/tidelift.exe -o tidelift.exe -o tidelift.exe 
 2. Provide permissions to run the CLI tool (eg. on Mac & Linux: chmod +x ~/bin/tidelift
If ~/bin is in your path, you will be able to use Tidelift CLI by running tidelift. Otherwise, ~/bin/tidelift.
 3. Authenticate your user by running   tidelift authenticate and pasting your user API key when prompted. You can create and view API keys for your user in the Tidelift web interface under Settings->API Keys.

Checking the Version

To check to see what version of the Tidelift CLI you are running, please run tidelift version.

If you have a pre-installation requirement to check the current version of Tidelift CLI, you can check the version at the following URL: https://download.tidelift.com/cli/tidelift-cli.version

Updating and removing

To update to the latest version of the CLI tool, you can run the command tidelift selfupdate

To uninstall Tidelift CLI, remove the downloaded binary from your computer (e.g. on Linux and MacOS, rm ~/bin/tidelift).

Next: Create a project

Still need help? Contact Us Contact Us