DOCS / GUIDES

Getting started

Install the CLI, log in, and hatch your first coop in under ten minutes.

Beginner8 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

Install the CLI, log in, and hatch your first coop in under ten minutes. The whole thing takes about 8 minutes, and the commands below are the ones you will use along the way.

$ brew install pollosoft/tap/cluck
$ cluck login
$ cluck init my-first-coop

Steps

  1. Install the CLI. The cluck CLI is a single binary. Install it with your package manager and run cluck doctor to make sure your perch is level.
  2. Log in. Run cluck login. A browser tab opens, a rooster crows once, and you are authenticated.
  3. Create a coop. A coop is your workspace. cluck init creates the directory, a coop.yolk file, and an empty .feed file for secrets.
  4. Run something. Try cluck roost to start the local dev server, then open the URL it prints and enjoy a freshly laid page.

Commands used

Keep going

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