Getting Started Deploying Custom Domains Environment Variables Database Addons Energy & Boosts CLI Reference API Reference MCP Integration

Getting Started

Deploy your first egg to Hatch in under a minute.

1. Install the CLI

Install the Hatch CLI:

curl -fsSL https://gethatch.eu/install | sh

Supports macOS and Linux (amd64/arm64).

2. Configure your token

Get an API token from gethatch.eu/dashboard/tokens, then configure the CLI:

hatch configure

Paste your API token when prompted. It's stored locally at ~/.hatch/config.json.

3. Deploy your egg

Deploy from your project directory:

hatch deploy

This creates an egg, creates a tar.gz artifact from your build output, and uploads it. You can optionally specify a custom name with --name myapp.

4. Redeploy

Every subsequent deploy is just:

hatch deploy

Hatch auto-detects your framework, installs dependencies, builds, and deploys. You'll get a live URL within seconds.

5. Visit your egg

After deployment completes, your egg is live at:

https://myapp-xxxx.nest.gethatch.eu

Each egg slug includes a random suffix (e.g. myapp-a1b2). Use hatch apps info to see your deployment details, or hatch open to open it in your browser.