DOCS / GUIDES

Hatching a project with Hatchback

Generate a production-ready project from a template.

Beginner7 min read
Before you beginYou need the cluck CLI, a Pollosoft account, and a coop to work in. No prior experience required. Curiosity and a mild fondness for chickens are helpful.

Overview

Generate a production-ready project from a template. The whole thing takes about 7 minutes, and the commands below are the ones you will use along the way.

$ cluck hatch api --name orders
$ cd orders
$ cluck roost

Steps

  1. Choose a template. cluck hatch --list shows web, api, worker, and the mysterious "omelette" template.
  2. Answer the questions. Hatchback asks for a name, a region, and your favorite grain. Only the first two matter.
  3. Inspect the result. You get a repo with tests, CI, a Dockerfile, and a README that is surprisingly accurate.
  4. Customize. Templates are just directories. Fork one and publish it to your coop so your team hatches things the way you like.

Commands used

Keep going

Stuck? Check the error codes, the FAQ, or the glossary.