Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.heex.io/llms.txt

Use this file to discover all available pages before exploring further.

This page describes manual / local Agent operations that complement the streamlined, cloud-based workflow. Use it for development, testing, or constrained deployments where you cannot (or do not want to) publish an Agent to the Cloud.

​
Manual (No-Cloud) Agent Installation

This is a manual, local alternative to the streamlined Dev Station → Production cloud-based workflow.
The procedure below shows how to install and run the Agent locally on any machine where the Heex SDK is available (Dev Station or not), without publishing or updating the Agent through the Cloud.

​
Prerequisites

  • Heex SDK installed on the machine
  • Your implementation binaries (Monitors and Recorders)
  • A target system identifier:
    • either a SYSTEM_ID, or
    • a local systemConf.json file

​
Procedure

  1. Follow the same preparation steps as in the streamlined workflow:
  2. Install the Agent without uploading it to the Cloud using one of the options below:
    • Option A — Install via CLI (recommended for local workflows) 
      cd ~/Heex_SDK_<version>/
heex agent install --system-id <SYSTEM_ID>
      • If you prefer using a local configuration file instead of a SYSTEM_ID, use: --config-path <path>/systemConf.json
    • Option B — Run the installer directly 
      ./Agent_<version>_<OS_and_Arch>_<system_id>_installer -- <optional arguments>
      Use -- to pass additional installer arguments (e.g., execution mode).
The same options and recommendations as the streamlined workflow still apply (e.g., using an external path, selecting an execution mode, service vs background process). See Cloud-based Agent installation