Here we outline how to get started working with Tidal Tools via the command line.
Downloading & Installing
Tidal Tools is a CLI utility that can be downloaded from https://get.tidal.sh. See below for getting setup quickly.
Open a terminal and run the following command:
curl https://get.tidal.sh/unix | bash
This will download the latest copy of tidal CLI and install it for you.
If you would like to see what the installation script is doing you can visit https://get.tidal.sh/unix and read the script in your browser first. If you would like to download a copy to install manually, perhaps on an air gapped machine you can visit https://get.tidal.sh and download them directly. Be sure to select the correct OS and architecture (32/64bit).
- Download the latest version for 64bit Windows here. For 32bit Windows download this version here.
- Run the downloaded file and follow the prompts to install.
N.B.: After installation you need to open a new terminal or Powershell window in order to begin using the tools. If that does not work, logging off and on again will reset your environment to include the newly installed tools.
Using the tools
To get started, from a new terminal or Powershell prompt, simply run:
To see what you can do with the tidal checkout some of our other articles about creating sync jobs or analyzing your applications via their URLs.
Connecting to the API
Once you have Tidal Tools installed you need to configure access to the API.
The credentials can be defined via a config file or via environment variables. If a config file is present it will be used, if it is not present environment variables will be used.
You can authenticate with the API with the command: tidal login
Alternatively, you can use the tidal config command to interactively set your credentials.
For example, you can set your username and password with the two following commands:
tidal config set tidal.email firstname.lastname@example.org
tidal config set tidal.password 1234567890asdfQWERTY@#$%
And you can set the URL with the following command:
tidal config set tidal.url https:://demo.tidalmg.com
Your credentials will be stored in a configuration file such as:
On macOS the config file is located: Library/Preferences/tidal/config.yaml
On Linux systems it is: $HOME/.config/tidal/config.yaml
And on Windows it is: %AppData%\tidal\config.yaml
If you use environment variables these variables need to be set:
Alternatively you can pass in your credentials on each request as command line arguments using the following flags:
Testing connectivity and authentication
Once you have set your credentials you can test your connectivity and authentication to the API with the ping command:
If you receive an error you can use the --debug flag to see what the issue is:
tidal ping --debug