Quick Start

Add your first project and visit it in the browser in under a minute.

Last updated: March 5, 2025

Quick Start

After installing Hatch and running hatch init + hatch up, you’re ready to add your first project.

Add a project

There are two ways to register a project with Hatch.

Option A: Quick add

hatch add myapp --proxy http://localhost:3000

This creates a project called myapp accessible at https://myapp.test, proxying to your local dev server on port 3000.

Option B: Per-project config

Create a hatch.yml in your project directory:

domain: myapp.test
services:
  web:
    proxy: http://localhost:3000

Then link it:

cd ~/projects/myapp
hatch link

See Per-Project Config for when to use each approach.

Visit your site

Open your project in the browser:

hatch open myapp

Or navigate directly to https://myapp.test. You should see a green lock with no certificate warnings.

Check status

hatch status

This shows the daemon state and all configured projects with their health status.

Next steps

Edit on GitHub