Skip to main content
System StatusContact Support Agility Community

Installing Client Tools

Instructions on how to install Continuum Client Tools.


Continuum comes with a complete set of command line tools that provide shell level access to the Continuum REST API.


Python 2.7.x and pip for installation. (Note: at this time Python 3 is not supported.)


These command line tools can be installed with the following command:

pip install

Test the Path

To make sure that the client tools are accessible, perform the following command:

which ctm-describe-api

... and the full path of the file location should be returned. If not, then look at the PATH setting in the .profile or .bash_profile and fix as necessary.

Configure .ctmclient.conf

The command line tools communicate with the Continuum server via the REST API. You can either pass in the connectivity parameters using arguments to the command, or put these in a file named .ctmclient.conf in the application user's home directory. 

More information on using the command arguments are below, but for now setup your .ctmclient.conf file.

Create a .ctmclient.conf file:

{"url": "http://SERVERADDRESS:8080", "token": "enter_token_here"}

To get the API token, log in to Continuum. From the menu at the top right, choose My Account, then Account Details. The token is the string of numbers at the top right of the modal.

My Account

Copy this API Token by highlighting and copying or by clicking the clipboard icon. Locate your `.ctmclient.conf` file and paste the string as the value for the token using a plain text editor and save. 

Run the following command:

ctm-describe-api -l

This should respond with a list of all REST API methods.


Visit the Continuum API Documentation ( for more information.