Installation

Prerequisites

• Python 3.11+
• uv package manager (recommended) or pip

Install the client

pip install hle-client

Or with uv:

uv pip install hle-client

Get an API key

1. Sign up at hle.world/register
2. Go to Dashboard > Keys
3. Click “New API Key” and copy the key

Expose a service

hle expose --service http://localhost:8123 --api-key hle_your_key

Your service is now accessible at https://<label>-<code>.hle.world

Save your API key

To avoid passing --api-key every time, set the environment variable:

export HLE_API_KEY=hle_your_key

Or save it permanently in your shell profile (~/.bashrc, ~/.zshrc, etc.).

The client also stores your key in ~/.config/hle/config.toml after the first successful connection.

Docker

Run the HLE client as a Docker container:

docker run -d --name hle-tunnel \
  -e HLE_API_KEY=hle_your_key \
  ghcr.io/hle-world/hle-client:latest \
  expose --service http://host.docker.internal:8123 --label ha

Kubernetes sidecar

Run the HLE client as a sidecar container alongside your app:

containers:
  - name: my-app
    image: my-app:latest
    ports:
      - containerPort: 8080
  - name: hle-tunnel
    image: ghcr.io/hle-world/hle-client:latest
    env:
      - name: HLE_API_KEY
        valueFrom:
          secretKeyRef:
            name: hle-credentials
            key: api-key
    command: ["hle", "expose", "--service", "http://localhost:8080", "--label", "myapp"]

Licensing

The HLE client is MIT-licensed open source. You can inspect the code, build from source, and verify that nothing shady happens with your traffic. The relay server at hle.world is a managed service.