Option | Short | Description |
---|---|---|
--help | -h | Show this help message and exit. |
--mode | -m | Set the Agent mode. Possibilities are upload-only (u ), no-connectivity (n ), or limited-connectivity (l ). |
--interactive | -i | Enable interactive mode during installation. |
--execution | -x | Set the execution mode to either background for background process or service . Default will be service if environment allows it, else background . |
--uninstall | -u | Uninstall. |
--execution
(or -x
) command, added with either service
or background
as an argument. Please understand that when in background process mode, any system reboot will not automatically re-run the Heex Agent
.
Example:
--uninstall
option and it’ll proceed to do so, no other input needed.
additionalAgentContent
folder, which is located at the root of your SDK folder. Any file or folder you add inside it will be copied into the Heex Agent with the same arborescence (they shall be copied inside <Agent_root>/additionalAgentContent/
).
additionalAgentContent/agentSetupHeader.sh
: The code added inside this file will be run (sourced) before any of the Agent implementations are startedadditionalAgentContent/AgentSetupFooter.sh
: The code added inside this file will be run (sourced) after any of the Agent implementations are started.bashrc
file before running.
In some advanced use cases, you may need to set some settings before running the executables.
FILES_TO_SOURCE_IN_SERVICES_ENV
inside the additionalAgentContent/agentSetupHeader.sh
script.
⚠️ Warning:
It is recommended to use full paths. The character ~
won’t always correctly reference paths to your HOME directory.
📝 Note: If you mean to source several files, know that the order of the declaration of each file in the list is the order in which we source the files.
additionalAgentContent/agentSetupHeader.sh
script as mentionned above to source it before the executable gets run.
📝 Note: Any external custom script is expected to be reachable at the given static path.
additionalAgentContent/agentSetupHeader.sh
is automatically generated and added into the packaged SDK, but if the file is not present, you can create it yourself at the root of the package, and paste the following inside it:
💡 Tip: If you already have created theadditionalAgentContent/agentSetupHeader.sh
script for other purposes, you can simply add theFILES_TO_SOURCE_IN_SERVICES_ENV
list into it
DISABLE_AUTOMATIC_ROS_INSTALL_SEARCH
. If you do not work with ROS2, you can ignore it. If you do, feel free to check out the specific ROS2 configuration page