Skip to main content

​
Prerequisites

  • Have a Heex CLI
  • Have a API_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 userconfig name. Available options:
  • --api-key: the API key to use for the login.
  • --save-as: userconfig name to save the configuration.
Usage: 
./heex login --api-key <API_KEY> --save-as <USERCONFIG_NAME>
This command will create a new userconfig in the configuration file and it will be set as default for future use. If you already have a userconfig saved and if you use the command ./heex login with no options, the command will use the default userconfig for the login. If you use the command ./heex login --api-key <API_KEY>, the command will search for a userconfig corresponding to the API key and if it finds one it will use it, otherwise you need to provide a userconfig 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 userconfig. Usage: 
./heex userconfig create --userconfig <USERCONFIG_NAME> --api-key <API_KEY> --set-default
Option --set-default is optional. If not provided, the userconfig will just be created/updated without being set as default.

​
How to manage userconfigs

To manage userconfigs, you can use the command ./heex userconfig. This command will allow you to create, list, remove and set a userconfig as default. Available options:
  • create: create a new userconfig.
  • list: list all userconfigs.
  • delete: delete a userconfig.
  • use: switch login to a specific userconfig.

​
How to list userconfigs

To list userconfigs, 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 userconfigs in the standard output, it will print only the userconfig name and the active userconfig. If you provide the option --output-file, you need to provide a .json file. This command will print the list of userconfigs 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 userconfig

To switch login to a specific userconfig, you can use the following command: Usage: 
./heex userconfig use <USERCONFIG_NAME>

​
How to delete a userconfig

To delete a userconfig, you can use the following command: Usage: 
./heex userconfig delete <USERCONFIG_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 userconfig from the configuration file. Next time you will need to login again you can use the following command: Usage: 
./heex userconfig use <USERCONFIG_NAME>

​
Getting Help

./heex login --help
./heex login --help
./heex userconfig --help
./heex userconfig use --help
./heex userconfig list --help
./heex userconfig create --help
./heex userconfig delete --help