CLI Reference

Deploy a pre-built app directory. Creates the egg if it doesn't exist.

Flags: --name, --deploy-target, --runtime, --start-command, --domain

Restart a running egg.

Permanently delete an egg.

Flags: --yes to skip confirmation

Configure the CLI with an API token.

Authenticate via browser OAuth.

Log out and clear local credentials.

Show current authentication status.

List your API keys.

List all your eggs.

Show detailed egg information.

View egg logs.

Flags: --build for build logs, --follow / -f for streaming, --lines / -n number of lines

Open egg in your browser.

Show energy status (account-wide or per-egg), including daily, weekly, bonus and pack balances.

Buy an Energy Pack — prints a Stripe Checkout URL; minutes are credited when the payment completes.

Boost an egg with extra energy.

Show the egg's CPU/memory limits (runtime profile or override).

Override the egg's memory limit (capped by tier: free 512 MB, Always On 1024 MB).

Register a scheduled task on your egg. The schedule is 5-field cron syntax (UTC); the command after -- runs on that schedule inside your egg's last deployed image.

Example: hatch cron add "*/5 * * * *" -- npm run digest

List scheduled tasks for your egg with their schedule, command, enabled state, last-run status, and next run.

Show stdout/stderr for a cron's runs (latest run by default).

Flags: --run <run-id> show a specific run

Delete a scheduled task and remove its periodic job.

Set environment variables.

Flags: --from-env / -f import from a .env file

Remove environment variables.

List environment variables with full secret values visible (passwords, tokens, keys are masked by default).

Provision a PostgreSQL database for your egg. Free tier: 50 MB, 10,000 rows.

Open a local TCP proxy to your egg's database and auto-launch psql.

Flags: --port / -p local port (default 15432), --host local address, --no-psql tunnel only

Show database status and usage for your egg.

Provision a persistent volume mounted at /data. Takes effect on the next deploy.

Flags: --size volume size in MB (default 1024), --app / -a egg slug

Show volume size, usage and mount point.

Detach the volume and delete it after a 7-day grace period.

Flags: --now delete immediately and irreversibly (skips the grace period)

Add a custom domain to your egg. Outputs DNS records and verification token.

Verify domain ownership via DNS TXT record and activate routing.

List custom domains and their verification status.

Remove a custom domain.

Deploy a preview environment (e.g. pr-42) for the current app. Repeat deploys update in place.

Flags: --json machine-readable output with the preview URL

List the app's preview environments with status and expiry.

Tear down a preview immediately.

Register an outbound deploy webhook. The signing secret is shown once.

Flags: --events (default deploy)

List webhooks with last delivery status.

Remove a webhook.

Send a signed ping event to verify your receiver.

Enable password protection (--off disables it; no flag shows the status).

Enable email-allowlist protection on the current directory's egg (replaces the current lists).

Flags: --email, --domain (at least one), --session-ttl magic-link session length, 1h to 30d or default (12h)

Show the allowlist and the session length.

Add or remove addresses and domains.

Set how long a magic-link sign-in lasts (1h to 30d, default 12h). Applies to new sign-ins.

Disable email-allowlist protection (also turns comments off).

Sign every visitor out (password and magic-link sessions).

Flags: --yes skip the confirmation (required without a terminal)

Turn comments on (the egg must be under email protection) or off, or show whether they are on and how many are stored.

Flags: --json (status)

List threads as a markdown report grouped by page (open threads by default).

Flags: --page, --open / --resolved / --deleted / --all, --since date, time or duration, --json

Show the full thread containing a comment, deleted replies included.

Flags: --json

Reply as Agent · <label> (- reads the text from stdin).

Flags: --as agent label (default: your token's name), --owner reply as yourself

Resolve or reopen the thread containing a comment.

Delete a comment (moderation; kept in history until purged).

Export every stored comment as JSON, deleted ones included.

Flags: --output / -o write to a file with owner-only permissions

Erase comments for good, no undo. A matched thread takes all its replies with it, whatever their author or date; export first to keep them.

Flags: --author EMAIL, --before DATE (combinable), or --all; --yes / -y skip the confirmation

Start the MCP tool server for AI assistants.

Print the CLI version.