Skip to main content
Welcome to the documentation for Heex CLI, a command-line tool designed to perform most operations on HeexSDK and interact with Heex’s Cloud.

​
Prerequisites

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

​
Supported Platforms

Heex CLI has been tested on the following platforms.
ArchitectureUbuntu 20.04 LTSUbuntu 22.04 LTSUbuntu 24.04 LTS
x86_64✅✅✅
ARM✅✅✅
If your system is not yet supported, contact us and we will work with you to provide you an adequate cli.

​
Getting started

​
Get the Heex CLI

You can directly fetch the CLI using command line. First, make sure you have the lsb-release package installed: 
sudo apt update && sudo apt install lsb-release
Then, in your terminal, run the following (replace <API_KEY> by your personnal user secret key): 
curl -X GET "https://api.app.heex.io/v1/cli/download?operating_system=$(( (($(lsb_release -sr | cut -d. -f1) - 20)/2*2) + ($(uname -m | grep -q 'x86_64' && echo 1 || echo 2)) ))" \
   -H "secret_key: <API_KEY>" -o heex && chmod +x heex
If you don’t have lsb-release installed and you can’t install it, please run following commands in your terminal to download the CLI: 
export OS_ARCH_MAP="20.04_x86_64=1;20.04_aarch64=2;22.04_x86_64=3;22.04_aarch64=4;24.04_x86_64=5;24.04_aarch64=6";

curl -X GET "https://api.app.heex.io/v1/cli/download?operating_system=$(echo "$OS_ARCH_MAP" | tr ';' '\n' | grep "^$(grep '^VERSION_ID' /etc/os-release | cut -d'=' -f2 | tr -d '"')_$(uname -m)=" | cut -d'=' -f2)" \
-H "secret_key: <API_KEY>" -o heex && chmod +x heex
If you already have the CLI installed, you can update it with the following command: 
./heex update --api-key <API_KEY>
Once you have your heex executable, you can get a list of all available CLI commands by calling: 
./heex --help
Enable shell autocompletion for subcommands and parameters: 
./heex integrate
Please follow the instructions written at the end of the integrate command to enable the autocompletion in your current terminal.

​
Commands

NameDescription
agentCommands related to the Heex Agent operations (i.e upload an agent).
datasourceCommands related to Data Source management (i.e add Data Source).
eventsCommands related to events management (i.e get events).
implementationCommands related to implementation management (i.e create new implementation).
integrateSets up autocompletion.
quotasProvides a list of available quotas for a given organization.
recordingsCommands related to recordings management (i.e download recordings).
sdkCommands related to SDK operations (i.e build the sdk).
systemCommands related to system management (i.e create new system).
triggerCommands related to trigger management (i.e create new trigger).
updateUpdates the CLI from the REST API with the latest version or with a given version.
workspaceCommands related to workspace management (i.e get storage information about a given workspace).

​
Getting Help

You can obtain extra help on usage per command or subcommands by using --help: 
./heex agent --help
./heex datasource --help
./heex events --help
./heex implementation --help
./heex integrate --help
./heex quotas --help
./heex recordings --help
./heex sdk --help
./heex system --help
./heex trigger --help
./heex update --help
./heex workspace --help