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 subscription 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 (Intel or with Rosetta installed):
curl https://download.tidelift.com/cli/tidelift_darwin -o ~/bin/tideliftNOTE
When installing on a Mac, you'll want to check to see if the directory ~/bin exists on your machine. If not, you will need to create this directory, or you can specify a different directory in the command.
MacOS (Apple Silicon):
curl https://download.tidelift.com/cli/tidelift_darwin_arm -o ~/bin/tideliftNOTE
When installing on a Mac, you'll want to check to see if the directory ~/bin exists on your machine. If not, you will need to create this directory, or you can specify a different directory in the command.
Windows:
curl https://download.tidelift.com/cli/tidelift.exe -o tidelift.exe
Windows/powershell:
Invoke-WebRequest -Uri https://download.tidelift.com/cli/tidelift.exe -OutFile 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
A SHA256 checksum of the current release is available at the following URL: https://download.tidelift.com/cli/tidelift-cli.sha256
To verify that this release comes from Tidelift, you can:
- Download the signature for the checksums file at https://download.tidelift.com/cli/tidelift-cli.sha256.sig
- And you can verify this using our public key https://download.tidelift.com/cli/TideliftPubkey.pem
- And running
openssl dgst -sha512 -verify TideliftPubkey.pem -signature tidelift-cli.sha256.sig tidelift-cli.sha256
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).
Recent changes to the CLI tool
Tidelift keeps a history of changes to the CLI. To see recent changes and bugfixes, see the CLI changelog.
Installing an older CLI version
The installation commands referenced earlier in this article will install the most recent release of the CLI available at the time of execution. If a previous version of the CLI needs to be installed it can be achieved by specifying the desired version number and operating system requirement (Darwin, Linux, Windows). Please see the CLI changelog to find previous versions.
Example:
curl https://download.tidelift.com/cli/1.12.6/darwin/tidelift -o ~/bin/tidelift
NOTE: Tidelift support CLI versions released within the previous 6 months.