Skip to main content

Install and configure the CLI

info

Crusoe Cloud is currently in alpha. If you do not currently have access, please request access to continue.

Install the CLI​

You can install the Crusoe CLI via a number of common package managers, including brew and apt.

On Linux, you can use apt to install the Crusoe CLI:

echo "deb [trusted=yes] https://apt.fury.io/crusoe/ * *" > /etc/apt/sources.list.d/fury.list
sudo apt update
sudo apt install crusoe

Configure the CLI​

The Crusoe CLI looks for a config file at ~/.crusoe/config which contains credentials as well as any defaults.

At a minimum, the following options are required to authenticate to the Crusoe CLI:

[default]
access_key_id="<access_key_id>"
secret_key="<secret_key>"

You can get your access key ID and secret key from the settings page on the Crusoe Cloud console. For more information, see "Manage your API keys".

Configure the CLI using environment variables​

If you wish to configure the CLI without a config file, you can provide equivalent environment variables:

  • CRUSOE_ACCESS_KEY_ID
  • CRUSOE_SECRET_KEY

Test the CLI​

If you've properly installed and configured the CLI, you should be able to run the whoami command and see the logged in user:

crusoe whoami
Welcome [email protected]! You are an admin of the domain.com organization.

You're now ready to go!

If you don't see this, make sure you've properly installed the CLI, provided a config file in the right location, and added the right credentials to the config file. If you've done all these things and it still isn't working, contact support.