Getting started

Complete Install first. These steps use the default Docker Compose backend. For the native backend (beta), read Try the native backend after this page.

Initialize one projectCopy Anchor Link

From a repository you own:

cd your-project
hack init

Review the generated .hack/ files before starting anything. Keep configuration in git and keep the secret key and local state out of it. For an existing Compose project, custom domains or agent-assisted setup, follow Project setup.

Start, inspect and stopCopy Anchor Link

hack up --detach
hack open
hack ps
hack logs --no-follow --tail 50

Expected: the declared services start, open prints or opens the instance URL, and ps shows service state. Visit the app and run its own health check. A URL or a running container alone does not prove the app works. If startup fails, read the error and run hack doctor before trying again.

hack down

Stop releases project-owned runtime processes. It does not delete application data or prune shared caches. Run and inspect covers selected services and log history.

NextCopy Anchor Link

• Core concepts explains projects, services and instances.
• Work on another branch runs a second instance beside the first.
• Agent handoff gives a coding agent the same documentation.

Source: v5 (next.12) · docs/site/getting-started.md.