Rescale CLI FAQ

Rescale CLI defaults to the US platform platform.rescale.com. If you are a user on any of the other global platforms (EU, JP, etc.), please specify your regional platform using the -X flag in your CLI command. For example:

java -jar /usr/local/bin/rescale.jar -X https://eu.rescale.com submit ...

In addition, there are a few advanced Java system properties that can be specified:

rescale.loglevel (TRACE, DEBUG, INFO, WARNING, ERROR, OFF)
https.proxyHost
https.proxyPort
https.proxyUser
https.proxyPassword

For example, to run with DEBUG logging turned on and use proxy.com:8888 as a proxy server, the following command can be used:

java -Drescale.loglevel=DEBUG -Dhttps.proxyHost=proxy.com -Dhttps.proxyPort=8888 -jar /usr/local/bin/rescale.jar status -p <api-token> -j <job-id>

Note: There is no spacing between the -D and the name of the system property. In addition, the -D switches should also be specified before the -jar option.

If the proxy requires Windows authentication, the https.proxyUser and https.proxyPassword system properties can be set. The https.proxyUser value should be set to DOMAIN\username. The https.proxyPassword property can be set to the Windows password for the user. If you do not want to embed the password in the command line, this property can be omitted and the CLI will prompt you to enter your password in the console when it launches.

During the uploading, after each file is successfully uploaded there will be a standard output indicating so. So the user can also redirect the output into a log file so all the successful uploads will be recorded.

java -jar /usr/local/bin/rescale.jar upload -p <api-token> -f <file1> ... <fileN> > upload_20141201.log

By default, the upload command will return a limited set of metadata for the uploaded file. To see an extended set of metadata, use the -e flag in the upload call:

java -jar /usr/local/bin/rescale.jar upload -p <api-token> -f <file1> ... <fileN> -e

Finally, if the CLI is being embedded in a larger script, then it is useful to use the --quiet flag to suppress non-json output from the command. This makes the parsing the response easier:

java -jar /usr/local/bin/rescale.jar --quiet upload -p <api-token> -f <file1> ... <fileN> -e
 
<script type="text/x-faq-end"></script>