Quick Start

Have your homelab service on the internet with SSO protection, all without leaving your terminal.

Three simple steps

1. Register at hle.world/register (email or GitHub/Google SSO)
2. Create an API key in your dashboard
3. Run one command to expose your service

Install the client

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

Alternatives: pipx install hle-client or brew install hle-world/tap/hle-client. Latest release is v2608.6. See Installation for details.

Expose your service

hle expose --service http://localhost:8080 --api-key hle_your_key_here

Tip

Your service is now live at https://myapp-x7k.hle.world (subdomain auto-generated from your user code). Authentication is enabled by default.

Configure API key location

The client checks for your API key in this order:

1. --api-key flag on the command line
2. HLE_API_KEY environment variable
3. ~/.config/hle/config.toml (saved after first use)

To save your key automatically:

export HLE_API_KEY=hle_your_key_here
hle expose --service http://localhost:8080
# Key is now saved to ~/.config/hle/config.toml

Caution

API keys are sensitive credentials. Never commit them to version control or share them publicly.

Keep it running

hle expose runs in the foreground and serves one service. For anything permanent, install it as a service that starts at boot:

hle service install --service http://localhost:8080 --label myapp

And if you want several services on this machine — managed from the dashboard rather than the command line — install the agent instead:

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

That enrolls the machine, installs the service, and from then on you add and remove endpoints at hle.world/dashboard.