​
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.
installPackage and install Heex Kernel and your implementation onto your computer. Note: Api-Key is mandatory.
uninstallUninstall Heex Kernel from your computer. Both background-process and service are removed.
deleteDelete agent from the cloud.
Usage: 
./heex agent SUBCOMMAND [--help]

​
How to package your own Heex Agent

To create your Agent installer locally, you may use the package functionality Available options:
  • --api-key: Provide your API_KEY. It is mandatory if you provide your system-id instead of the path to your system-conf. No need to provide if you have an active userconfig.
  • --config-path: If you have the systemConf.json path, provide it here. It shall be packaged inside your installer.
  • --system-id: If you don’t have the systemConf.json yet, you may provide the system-id here. It shall use your api key to download the systemConf.json
  • --path-to-sdk: 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 path/to/sdk/folder).
Usage: 
./heex agent package --path-to-sdk /path/to/sdk/folder --system-id <SYSTEM_ID>
Or with config path: 
./heex agent package --config-path /path/to/systemConf.json --path-to-sdk /path/to/sdk/folder

​
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. Available options:
  • --api-key: Add your user API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --system-id: 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-id ID1 --system-id 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-id option. (usage: --config-path path/to/systemConf.json).
  • --path-to-sdk: 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 path/to/sdk/folder).
Usage: 
./heex agent upload --path-to-sdk /path/to/sdk/folder --config-path path/to/systemConf.json
Or with system IDs: 
./heex agent upload --path-to-sdk /path/to/sdk/folder --system-id <SYSTEM_ID1> --system-id <SYSTEM_ID2>

​
How to install your own Heex Agent onto your computer

Heex Agent can be directly installed onto your local computer. Available options:
  • --api-key: Add your user API_KEY which can be found on the cloud. Required to add the system’s secret key to the credentials file [required]. No need to provide if you have an active userconfig.
  • --config-path: Path to the systemConf.json configuration file [required].
  • --path-to-sdk: 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 path/to/sdk/folder).
  • --execution-mode: ‘background’ or ‘service’ (optional, defaults to service).
  • --auto-approve: In case an Agent is already installed on your system, setting this flag will automatically approve the uninstallation of the current Agent before installing the new one. Usage:
./heex agent install --path-to-sdk /path/to/sdk/folder --config-path path/to/systemConf.json
With execution mode: 
./heex agent install --path-to-sdk /path/to/sdk/folder --config-path path/to/systemConf.json --execution-mode background

​
How to uninstall your own Heex Agent onto your computer

Heex Agent can be uninstalled from your local computer with a simple command. Usage: 
./heex agent uninstall

​
How to delete an agent from the cloud

You can delete an agent from the cloud using the delete subcommand. Available options:
  • --api-key: Provide your API_KEY [required]. No need to provide if you have an active userconfig.
  • --agent-id: ID of the involved agent [required].
Usage: 
./heex agent delete --agent-id <AGENT_ID>

​
Getting Help

./heex agent --help
./heex agent package --help
./heex agent upload --help
./heex agent install --help
./heex agent uninstall --help
./heex agent delete --help