Skip to content
Login

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

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

Alternatives: pipx install hle-client or brew install hle-world/tap/hle-client. See Installation for details.

Expose your service

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

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:

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