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 an API_KEY. Should be accessible in your personal 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 install our CLI via apt:

​
Add Heex to your apt trusted environments

If this is the first time you 
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://apt.heex.io/heex-apt-gpg-key.gpg -o /tmp/heex-apt-gpg-key.gpg
sudo mv /tmp/heex-apt-gpg-key.gpg /etc/apt/keyrings/
sudo chmod 644 /etc/apt/keyrings/heex-apt-gpg-key.gpg

DISTRO_CODENAME=$(lsb_release -cs 2>/dev/null || . /etc/os-release && echo "$UBUNTU_CODENAME")
echo "deb [arch=amd64,arm64 signed-by=/etc/apt/keyrings/heex-apt-gpg-key.gpg] \
https://apt.heex.io/apt-repository ${DISTRO_CODENAME} main" | sudo tee /etc/apt/sources.list.d/heex-apt.list > /dev/null

​
Install the heex-cli

sudo apt update
sudo apt install heex-cli
Once installed, re-load your terminal, and from there you can call our cli using the heex command. Any future update of our CLI shall be retrieved using sudo apt update && sudo apt install --only-upgrade heex-cli
📝 Note: Note If for some reason you can’t install via apt, you can also direct-download our CLI

​
How to login to the Heex CLI

To login to the Heex CLI, you can use the following command: Usage: 
heex login --api-key <API_KEY> --save-as <PROFILE_NAME>
Once you have logged in, you don’t need to provide the --api-key option anymore.

​
How to manage profiles

To manage profiles, you can use the following command: Usage: 
heex userconfig <command>

​
How to logout from the Heex CLI

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

​
How to generate LLM instruction files

Download LLM Knowledge Base using the following command: Usage: 
heex llm --output-file <LLM_KNOWLEDGE_BASE_FILE_NAME>

​
Commands

NameDescription
agentCommands related to the Heex Agent operations (i.e., upload an agent).
completionSets up autocompletion.
datasourceCommands related to Data Source management (i.e., add Data Source).
loginLogin to the CLI.
logoutLogout from the CLI by removing the active userconfig.
eventsCommands related to events management (i.e., get events).
implementationCommands related to implementation management (i.e., create new implementation).
llmCommands related to LLM instruction files for CLI automation.
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).
signalCommands related to signals management (i.e., create new signals).
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.
userconfigManage user userconfigs.
whoamiShow current user and workspace information.
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 completion --help
heex datasource --help
heex login --help
heex logout --help
heex events --help
heex implementation --help
heex llm --help
heex quotas --help
heex recordings --help
heex sdk --help
heex signal --help
heex system --help
heex trigger --help
heex update --help
heex userconfig --help
heex whoami --help
heex workspace --help
[Not recommended] Following commands are for any user that can’t install the CLI via the apt process:

​
How to direct download the CLI

In your terminal, run the following: 
curl --fail -X GET "https://api.app.heex.io/v1/cli/download?operating_system=$(. /etc/os-release && echo ${ID}_${VERSION_ID}_$(uname -m))" \
   -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: 
sudo ./heex completion
Please follow the instructions written at the end of the completion command to enable the autocompletion in your current terminal.