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

​
Prerequisities

  • A Heex_SDK_<version> folder with the heex CLI executable present at his root. This folder can be downloaded on Heex’s Cloud for versions above 2.25.0.

​
Getting started

For a list of all available CLI commands

./heex -h

Enable shell autocompletion for subcommands and parameters (only Linux systems are supported):

./heex integrate

Please follow the instructions written at the end of the integrate command to enable the autocompletion in your current terminal.

​
Commands

NameDescription
integrateIntegrate Heex CLI into the system
sdkManage the SDK operations(i.e build)
hreManage the installer operations(i.e package)
cloudInterface to interact with Heex’s Cloud

​
Getting Help

List all commands and options using:

./heex --help

You can obtain extra help on usage per command using:

./heex sdk --help