1.1X Rescale CLI Basics

For using the Rescale CLI commands, the Rescale API key must be used every time. Since the API Key is a long combination of letters and numbers, it will be helpful to create an environment variable and save it in your profile so that you can conveniently use the API variable rather than the actual key every time you use the commands. As an alternative option, a configuration file can be created with your profile to use CLI commands without using the API key every time. You can follow the steps outlined below to either create an environment variable or create a configuration file with your profile:

On Linux

Setting API Key Environment Variable

• On your terminal, type either vi ~/.bashrc OR vi ~/.bash_profile and hit ENTER.
• This opens up a terminal editor where you can type the following : export RESCALE_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
• Once you finish typing, hit ESC first and then type :wq to save the changes.
• You can test the variable by displaying the variable using echo $RESCALE_API_KEY. This will display the Rescale API key on the terminal.

Using Profiles in a Configuration File

• By default, the CLI will look for the profile file in ~/.config/rescale/apiconfig. As a first step, create a Rescale directory mkdir ~/.config/rescale. Next, create the configuration file vi ~/.config/rescale/apiconfig and add the following contents:

[default]
apikey = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

The CLI will use the [default] profile automatically. A different named profile can be specified by using the --profile command line argument. It is also possible to use a different config file path by setting the RESCALE_CONFIG_FILE environment variable to the desired path.

If a user is using multiple profiles for different platforms they have to specify the URL to those platforms in the apiconfig as follows:

[default]
apibaseurl = https://platform.rescale.com
apikey = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

[eu]

apibaseurl = https://eu.rescale.com apikey = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

---

On Windows

Setting API Key Environment Variable

• On your terminal, enter the following: set RESCALE_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
• You can double check if the API key has been added to the environment variables by typing echo %RESCALE_API_KEY%

This should display the API key you added.

Using Profiles in a Configuration File

By default, the CLI will look for the profile file in %USERPROFILE%.configrescaleapiconfig. As a first step, navigate to your %USERPROFILE% directory. Create a folder .config and a rescale folder under that. Inside .configrescale, open notepad and add the following contents:

[default]
apikey = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

While saving the file, type the file name as "apiconfig" (With the double quotes to save it without any file extension) and save as All Files type.

The CLI will use the [default] profile automatically. A different named profile can be specified by using the --profile command line argument. It is also possible to use a different config file path by setting the RESCALE_CONFIG_FILE environment variable to the desired path.

If a user is using multiple profiles for different platforms they have to specify the URL to those platforms in the apiconfig as follows:

[default]
apibaseurl = https://platform.rescale.com
apikey = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

[eu]

apibaseurl = https://eu.rescale.com apikey = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX