HLE Client

HomeLab Everywhere — Expose homelab services to the internet with built-in SSO authentication, WebSocket support, and webhook forwarding.

One command: hle expose --service http://localhost:8080

Your local service gets a public URL like myapp-x7k.hle.world with automatic HTTPS and SSO protection.

Install

Curl installer (recommended)

curl -fsSL https://get.hle.world | sh

Installs via pipx (preferred), uv, or pip-in-venv. Supports --version:

curl -fsSL https://get.hle.world | sh -s -- --version 2607.7

pipx

pipx install hle-client

Homebrew

brew install hle-world/tap/hle-client

Quick Start

1. Sign up at hle.world and create an API key in the dashboard.

2. Save your API key:

hle auth login

This opens the dashboard in your browser. Copy your key and paste it at the prompt. The key is saved to ~/.config/hle/config.toml.

3. Expose a service:

hle expose --service http://localhost:8080

# Or forward webhooks from GitHub/Stripe:
hle webhook --path /hook/github --forward-to http://localhost:3000 --label github-hook

CLI Usage

hle expose

Expose a local service to the internet.

hle expose --service http://localhost:8080              # Basic usage
hle expose --service http://localhost:8080 --label ha   # Custom subdomain label
hle expose --service http://localhost:3000 --auth none  # Disable SSO
hle expose --service http://localhost:8080 --no-websocket  # Disable WS proxying
hle expose --service http://localhost:8080 --allow user@gmail.com  # Allow a specific user
hle expose --service http://localhost:8080 --allow google:user@gmail.com --allow github:dev@co.com

Options:

• --service — Local service URL (required)
• --label — Service label for the subdomain (e.g. ha → ha-x7k.hle.world)
• --auth — Auth mode: sso (default) or none
• --allow — Allow an email to access the tunnel (repeatable). Format: email or provider:email
• --websocket/--no-websocket — Enable/disable WebSocket proxying (default: enabled)
• --verify-ssl — Enable SSL certificate verification for the local service (default: off, accepts self-signed)
• --upstream-basic-auth USER:PASS — Inject Basic Auth into requests forwarded to the local service
• --forward-host — Forward the browser's Host header to the local service
• --api-key — API key (also reads HLE_API_KEY env var, then config file)

hle update

Update the client to the latest version, regardless of how it was installed (pipx, uv tool, the installer's venv, or pip). It detects the install method and runs the right upgrade.

hle update            # upgrade to the latest release
hle update --check    # just report current vs. latest, don't change anything
hle update --version 2607.7   # pin an exact version

After updating, restart any running tunnels (e.g. systemctl restart hle-<label>) so they pick up the new version.

hle service

Install and manage a background service for a tunnel, so it survives reboots and restarts on failure. Uses systemd on Linux and launchd on macOS (Windows is unsupported — use Task Scheduler or NSSM). The API key is read at runtime from ~/.config/hle/config.toml (or HLE_API_KEY) and is never written into the service file.

# Install + start a system service
#   Linux → /etc/systemd/system/hle-tv.service
#   macOS → /Library/LaunchDaemons/world.hle.tv.plist
sudo hle service install --service http://localhost:9998 --label tv

# Custom zone / extra expose options are supported
sudo hle service install --service https://192.168.2.200:8006 --label prox --zone pr.t00t.us

# Per-user service (no sudo)
#   Linux → ~/.config/systemd/user/hle-tv.service
#   macOS → ~/Library/LaunchAgents/world.hle.tv.plist
hle service install --user --service http://localhost:9998 --label tv

hle service status --label tv       # service status
hle service list                    # list all hle services
hle service uninstall --label tv    # stop, disable, remove the service

hle webhook

Forward incoming webhooks to a local service.

hle webhook --path /hook/github --forward-to http://localhost:3000 --label github-hook
hle webhook --path /hook/stripe --forward-to http://localhost:4000/stripe --label stripe-hook

Options:

• --path — Webhook path prefix, e.g. /webhook/github (required). Cannot be /
• --forward-to — Local URL to forward webhooks to (required)
• --label — Webhook label, e.g. github-hook (required)
• --api-key — API key (also reads HLE_API_KEY env var, then config file)

Webhook tunnels bypass SSO so external services (GitHub, Stripe, etc.) can deliver payloads without authentication.

Server notices

While a tunnel is connected, the relay can push informational messages that the client renders to stderr (e.g. ✓ Auto-protect added you@example.com via Google SSO). Wording is server-controlled so new notices do not require a client release.

hle auth

Manage your API key.

hle auth login                              # Save key (opens dashboard)
hle auth login --api-key hle_xxx            # Save key non-interactively
hle auth status                             # Show current key source
hle auth logout                             # Remove saved key

hle config

All tunnel and client configuration lives under hle config. Tunnel subcommands accept a label (resolved to <label>-<user_code>) or a full subdomain.

hle config show / list

hle config list                       # List your active tunnels
hle config show ha                    # Full status for one tunnel (auth, rules, PIN, …)

hle config auth-mode

hle config auth-mode ha --set sso     # SSO gate on
hle config auth-mode ha --set none    # Tunnel becomes public

hle config access — SSO email allow-list

hle config access list ha                                # List rules
hle config access add ha friend@example.com              # Allow an email
hle config access add ha dev@co.com --provider github    # Require GitHub SSO
hle config access remove ha 42                           # Remove rule by ID
hle config access replace ha google:alice@x.com github:bob@y.com   # Declarative — adds + prunes
hle config access replace ha --clear                     # Remove all rules

replace is declarative: rules on the server but not in the args are removed. hle expose --allow remains additive (never prunes) for ad-hoc sessions.

hle config pin

hle config pin set ha          # Set a PIN (prompts for 4-8 digits)
hle config pin status ha       # Check PIN status
hle config pin remove ha       # Remove PIN

hle config basic-auth

hle config basic-auth set ha          # Prompts for username + password (min 8 chars)
hle config basic-auth status ha       # Check Basic Auth status
hle config basic-auth remove ha       # Remove Basic Auth

hle config share — temporary share links

hle config share create ha                        # 24h link (default)
hle config share create ha --duration 1h          # 1-hour link
hle config share create ha --max-uses 5           # Limited uses
hle config share create ha --label "demo"         # Label for reference
hle config share list ha                          # List share links
hle config share revoke ha 42                     # Revoke a link

Global Options

hle --version    # Show version
hle --debug ...  # Enable debug logging

Configuration

The HLE client stores configuration in ~/.config/hle/config.toml:

api_key = "hle_your_key_here"

API key resolution order:

1. --api-key CLI flag
2. HLE_API_KEY environment variable
3. ~/.config/hle/config.toml

Development

git clone https://github.com/hle-world/hle-client.git
cd hle-client
uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check src/ tests/
ruff format --check src/ tests/

License

MIT — see LICENSE.