Authentication

​

Prerequisites

• Have a Heex CLI
• Have a USER_SECRET_KEY. Should be accessible in your personnal space on the heex cloud platform.

​

Usage

Usage:

./heex login SUBCOMMAND [--help]
./heex userconfig SUBCOMMAND [--help]
./heex logout [--help]

​

How to login to the Heex CLI

There are two ways to login to the Heex CLI using the command ./heex login or ./heex userconfig. When you run ./heex login for the first time you need to provide at least an API key and a profile name. Available options:

• --api-key: the API key to use for the login.
• --save-as: profile name to save the configuration.

Usage:

./heex login --api-key <USER_SECRET_KEY> --save-as <PROFILE_NAME>

This command will create a new profile in the configuration file and it will be set as default for future use. If you already have a profile saved and if you use the command ./heex login with no options, the command will use the default profile for the login.

If you use the command ./heex login --api-key <USER_SECRET_KEY>, the command will search for a profile corresponding to the API key and if it finds one it will use it, otherwise you need to provide a profile name.

The second way to login to the Heex CLI is to use the command ./heex userconfig create. This command will allow you to create a new profile.

Usage:

./heex userconfig create --profile <PROFILE_NAME> --api-key <USER_SECRET_KEY> --set-default

Option --set-default is optional. If not provided, the profile will just be created/updated without being set as default.

​

How to manage profiles

To manage profiles, you can use the command ./heex userconfig. This command will allow you to create, list, remove and set a profile as default. Available options:

• create: create a new profile.
• list: list all profiles.
• delete: delete a profile.
• use: switch login to a specific profile.

​

How to list profiles

To list profiles, you can use the following command:

Usage:

./heex userconfig list --output-file <OUTPUT_FILE_PATH>

If you don’t provide the option --output-file, the command will print the list of profiles in the standard output, it will print only the profile name and the active profile.

If you provide the option --output-file, you need to provide a .json file. This command will print the list of profiles with names and API keys. Be careful with this option if you don’t want to expose your API keys.

​

How to switch login to a specific profile

To switch login to a specific profile, you can use the following command:

Usage:

./heex userconfig use <PROFILE_NAME>

​

How to delete a profile

To delete a profile, you can use the following command:

Usage:

./heex userconfig delete <PROFILE_NAME>

​

How to logout from the Heex CLI

To logout from the Heex CLI, you can use the following command:

Usage:

./heex logout

This command will remove the active profile from the configuration file. Next time you will need to login again you can use the following command:

Usage:

./heex userconfig use <PROFILE_NAME>