Recipes

The commands and configuration on this page were audited against v5.0.0-next.14. The execution notes below come from the newer recipe source revision; the examples were not rerun with the pinned binary.

Step-by-step setups for using Hack with other tools and for everyday workflows. Each recipe has a complete project under examples/recipes or examples/configs, and each page says what was tested and what was not.

They all use the supported building blocks: lifecycle hooks and processes, managed env and overlays, hack run, hack exec and hack host exec. They run on the default Compose backend.

Other toolsCopy Anchor Link

• Sign in to another CLI at startup: a hook signs in to a deploy or edge platform CLI and hands the token to your services.
• Expose a local service through a tunnel: a public URL for webhooks and OAuth callbacks, started and stopped with the project.
• Use a remote database: a proxy as a lifecycle process, one overlay per database, and guard rails for production.

Everyday workflowsCopy Anchor Link

• Run database migrations: by hand, on every start, and per branch instance.
• Switch between environments: development, QA and production-like settings with env overlays.
• Install dependencies in a deps service: install inside the container, once, into a shared volume.
• Dependency directories and caches: where node_modules, build output and caches live, and the native backend's differences.
• Clean up: branch instances, worktrees, orphaned containers, volumes and stale node_modules.

Copy-paste setupsCopy Anchor Link

• Config examples: complete .hack/ setups for a web app with Postgres, an API with a worker and a queue, a monorepo, a Python app, a static site, and a dev server on your machine.

When something goes wrongCopy Anchor Link

• Common pitfalls: small, easy-to-hit problems and what to do instead.
• Run hack doctor and follow its advice.

---

Source: Recipe corrections (next.14 compatible) · docs/recipes/README.md.