Here we outline how to get started working with Tidal Tools via the command line.
Downloading & Installing
Tidal Tools is a cross platform CLI utility that you can use to discover and analyze your applications. Easily install Tidal Tools on your operating system.
If you plan to use the
tidal analyze code command to analyze your source code
tidal analyze db to analyze your databases, you will need to install
Docker Community Edition. To install Docker on your system you can check
Docker’s documentation directly. Once
installed you can verify it is installed and working
correctly with the command
Docker for Windows supports both Linux containers and Windows containers, however Tidal Tools works when your Docker installation is set to to use Linux containers. Set up Docker for Windows to use Linux containers.
Using Tidal 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. Register for a free account with Tidal Migrations to get the connection details.
There are several ways to authenticate with the Tidal Migrations API, we
recommend the first one,
tidal login, because your password is never
persisted to disk.
Tidal Login command
To authenticate with the API type
tidal login and follow the prompts. This
should provide and store an access token for you that gives you access for 8
hours. Once it is expired, the user must login again and obtain another token.
We recommend that you utilise this command because it doesn’t store your password. If you must store the password, you can authenticate using the methods below.
Alternative authentication methods
Alternatively, you can use the
tidal config command to manually set your
For example, you can set your username, password and URL with the three following commands:
tidal config set tidal.email [set your email] tidal config set tidal.password [set your password] tidal config set tidal.url https://demo.tidalmg.com
Your credentials will be stored in a configuration file such as:
tidal: email: my_user_name_here password: my_secure_password_here url: https://my_instance_name_here.tidalmg.com
On macOS the config file is located:
On Linux systems it is:
And on Windows it is:
You can specify your credentials as environment variables. If so, these variables need to be set:
Alternatively you can pass in your credentials on each request as command line arguments using the following flags:
--tidal-email email@example.com --tidal-password your_secure_password --tidal-url https://yoursubdomain.tidalmg.com
Testing connectivity and authentication
Once you have set your credentials you can test your connectivity and authentication to the API with the ping command:
Using a Proxy
If you need to use a proxy, you can specify it with the
On macOS and Linux you would run:
and on Windows:
Of course replacing
18.104.22.168 with your proxy IP address and
123 with the
Once you have this set, you should be able to run
tidal ping successfully.
Remember that you will need to set this for every new terminal session you