Set up Calyptia CLI

After you've installed Calyptia CLI, refer to this guide to complete your setup and learn more about supported commands.

Authenticate with Calyptia services

To authenticate your Calyptia CLI instance:

1. Go to the Calyptia Core dashboard (opens in a new tab).

2. In the navigation menu, select Settings > Generate API key.

3. Under Generate API key, enter a name for your new API key, then select Generate.

4. Run the following command in Calyptia CLI:

   calyptia config set_token KEY

   Replace KEY with the value of the API key you generated in the previous step.

Enable autocomplete

Calyptia CLI includes an optional autocomplete feature that suggests command names as you type. To enable this feature:

1. Run the following command to view a list of supported shell environments:

   calyptia completion -h

2. Run the following command:

   calyptia completion ENV -h

   Replace ENV with the name of your shell environment (for example, bash).

3. Follow any additional instructions that print in your terminal. Depending on your environment, you might need to install additional dependencies.

View command list

To view a full list of available commands and flags, run:

calyptia help

You can also prepend calyptia help to a specific command to view more information about that command.