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.

Heex docker hub: https://hub.docker.com/r/heex
Pre-configured Heex Docker Images let you run Heex Agent in a container with no local installation. Use them to try Heex quickly, run agents in your own infrastructure, or integrate into CI and edge deployments. Each image is self-contained and documented below.

​
heex-agent

Minimal image to run the Heex Agent for an existing system. The image handles agent download, installation, and execution; it does not create systems. Create your system, datasources, triggers, and implementations in the Heex Platform first, then run this image with your credentials.
VariableRequiredDescription
SYSTEM_IDYesYour Heex system ID (e.g. s-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
HEEX_API_KEYYesYour Heex API key, available under Account → API Keys. Any workspace member’s key can be used.
HEEX_API_KEY is used at container startup to authenticate and provision the Agent. Without --rm, the container persists across restarts and the key is only required on the first launch. With --rm, the container is removed when stopped, so the key is required at each docker run.
Quick run (interactive): 
docker pull heex/heex-agent:latest
docker run --rm -it -e SYSTEM_ID="<your-system-id>" -e HEEX_API_KEY="<your-api-key>" heex/heex-agent:latest
Run in the background (persistent): 
docker run -d -e SYSTEM_ID="<your-system-id>" -e HEEX_API_KEY="<your-api-key>" --name heex-agent heex/heex-agent:latest
  • Base: Ubuntu 24.04, multi-arch (amd64, arm64), ~250 MB
  • First start: The agent is downloaded and installed on first run (~30 s), as well as the heex-installer and heex CLIs. Later starts are faster on an existing container.
  • Image: Docker Hub — heex/heex-agent

​
heex-dev

Docker image to develop using the Heex SDK. It contains with all the requirements installed to develop using the Heex SDK, or build and compile an agent. It installs the latest heex and heex-installer CLIs at startup. Quick run: 
docker pull heex/heex-dev:latest
docker run --rm -it heex/heex-dev:latest
  • Base: Ubuntu 24.04, multi-arch (amd64, arm64), ~750 MB
  • First start: The heex-installer and heex CLIs are downloaded.
  • Image: Docker Hub — heex/heex-dev