Setting up Rescale CLI

A command-line app for submitting jobs to Rescale

The Rescale Client App or Rescale Command Line Interface (CLI) is a Java-based client application for submitting and managing jobs to Rescale without having to explicitly know the Rescale API. Aside from providing a simple command line utility for the Rescale API, it also integrates the multi-threaded transfer library for uploading files directly to the Rescale Cloud Storage. This also handles any authentication related to uploading/downloading files from the Rescale Data Store. The App has several main functions:

  • Submit: submitting a job in the current working directory to Rescale
  • Status: obtaining the status of a running job on Rescale
  • Sync: syncing output files of jobs to your hard drive
  • Retrieve Info: retrieve metadata from the Rescale API

This section describes the steps needed to set up the Rescale CLI App on your local workstation. Rescale CLI version 1.1.0 and higher does not require a seperate Java install. The Java RTE is packaged into the installation package for the CLI.


In order to utilize the Rescale CLI App, an API key token must be generated to properly identify the user and associated account.

To create this API token, in the Rescale Web UI, click on the drop down menu associated with the user account name (usually your email address) in the upper right hand corner. Select Account from the drop down menu. Then from the navigation menu on the left choose API. This should bring you to: https://platform.rescale.com/user/settings/api-key/

From this page, click the Generate button to create a new API key. Make note of this string, but you can return to the page at anytime to retrieve it. This string is your private <api-token>.

API-CLI Download

On the Rescale API page, below your API token, the Rescale CLI Java-based app that is suitable to your OS can be downloaded.

Once downloaded, install the CLI App on your computer.

For MacOS and Windows, click on the install package and follow the prompts on the installation wizard.

If you are installing the rpm package on Linux OS, you can use the following command:

sudo rpm -i <installer>

If you are installing the .deb package on Ubuntu, you can use the following command:

sudo dpkg -i <installer>