Using the Continuum Command Line Tools

Last updated
Save as PDF

The list of Continuum command line tools that provide shell level access to the Continuum REST API.

Overview

Naming

All commands start with a `ctm-` prefix, to separate them from any other commands that may be in your PATH.

Passing Credentials via Command Line

If you chose not to use the .ctmclient.conf file for any reason, you can still pass in the address and credentials as arguments to the commands.

Each command will accept REST API connection parameters as command line arguments (preferred — [how to find your token](#findtoken)):

ctm-version --url http://localhost:8080 --token enter_token_here

Alternative method:

ctm-version --url http://localhost:8080 --access-key username --secret-key password

As an additional option, `--config foo.conf`, allows you to specify a different json configuration file other than .ctmclient.conf in the user's home directory. This allows you to save your credentials, if desired, in a different directory or file.

Any arguments passed on the command line take precedence over values stored in config files.

If url and credentials are put in a config file, then the commands can be executed more simply:

ctm-version

Standard Arguments

All commands accept the following common arguments:

        -A,--access-key          A defined username.
        -S,--secret-key          A valid password.
        -T,--token               A defined user UUID 'token'.
        -C,--config              Read credentials and URL from the
                                      specified json formatted config file. If a
                                      config file and
                                      -A, -U or -S flags are used on the same
                                      command, the flag option parameters take
                                      precendence
        -F,--format              The output format.  (default=text,
                                      values=xml/json.)
                                      Valid Values: text|json|xml
        -L,--output_delimiter    Delimiter for "Text" output format.
                                      (Default is TAB)
        -D,--debug               Turn on debugging output.
        -H,--help                Display this help message.
        -U,--url                 URL of the REST API endpoint. E.g.:
                                      http://address:port
        --force                  Force "yes" on "Are you sure?" prompts.
        --noheader               For "text" output format, omit the column
                                      header.
        --dumpdoc                Writes documentation for the command in
                                      Markdown format.
        --api                    Identifies the API endpoint associated
                                      with this command.

Command Specific Arguments

To see the specific arguments per command line tool, use the `--help` option as follows.

ctm-list-tasks --help

Full Command Listing and Help

See Command Reference for a full listing of the commands available and their usage.

Special Note for Windows installation using Python 2.7

Python scripts will sometimes expect a parameter and will not work unless the registry entry for Python is updated. To solve this problem, navigate to the following registry key in the Windows registry:

HKEY_CLASSES_ROOT\Applications\python26.exe\shell\open\command

And set its value to the following:

"C:\Python26\python26.exe" "%1" %*