<USER_SECRET_KEY>
by your personnal user secret key):
heex-installer
, or you can install an existing system that has already been set up:
⚠️ Warning: system name with special characters
If your system name contains special characters (i.e ’), use double quotes before and after your names.
For example, for a system called test’s system, provide that as --name
“test’s system”.
📝 Note: You can call./heex-installer --help
to list the different--system-category
possible values, and more.
Option | Description |
---|---|
--help , -h | Show this help message and exit. |
--version , -v | Shows the version of the heex-installer. |
--system-id , -si | [optional] System ID. If not given, you will create a new system. |
--api-key , -k | Add your user api secret_key which can be found on the cloud. |
--execution-mode , -x | [optional] Execution mode: ‘background’ for background process or ‘service’ (default). |
--name , -n | [mandatory if no system-id provided] System code name (name display for your system in the UI). If the name of your system contains special characters such as ’, enclose with double quotes "". For example, —name “John’s dev station”. |
--system-middleware , -mid | [optional] System middleware. To see available options, please run ./heex-installer --help . |
--system-category , -cat | [mandatory if no —system-id given] System category. To see available options, please run ./heex-installer --help . |
--installed-version , -iv | [optional] Forces the installed agent version to given one. Example: --installed-version 2025.7.1 |
heex-installer
the same way as with the CLI
. If you intend to do so, please take a look at how to use a Proxy with the CLI.