​
Prerequisites

​
Usage

SubcommandDescription
packageCreate an installer with Heex Kernel and your implementations.
uploadCreate an installer with Heex Kernel and your implementations, and release it onto your system(s). Several system ids can be provided if built agent needs to be uploaded on several systems at once. Note: Api-Key is mandatory.
Usage: 
./heex agent SUBCOMMAND [--help]

​
How to release Your Own Heex Agent

To take advantage of the ease of deployment and over-the-air update capabilities, you need to release your Heex Agent to our Cloud. Please use the command below, using the OPTIONS depending on your needs (described below): Usage: 
./heex agent upload --api-key <USER_SECRET_KEY> OPTIONS
The OPTIONS that you have when uploading a Heex Agent are:
  • --system-ids: with this option you can specify one or several system-id’s to which you would like to upload your packaged Agent. Please use the option for each id you want. (usage: --system-ids ID1 --system-ids ID2 …).
  • --config-path: alternatively to the option mentionned above, you can also provide the path to a specific systemConf.json. This will then include the systemConf inside the package and upload the Agent to given system. Note that this implies that you can only upload to one system at the time, and it cannot be combined with the --system-ids option. (usage: --config-path path/to/systremConf.json).
  • --path-to-sdk-package: use this option if you run the Heex CLI from a location that is not inside a SDK folder, so that you can point to the root of the SDK folder. (usage: --path-to-sdk-package path/to/sdk/root).

​
Getting Help

./heex agent --help
./heex agent package --help
./heex agent upload --help