DOCS / CLI REFERENCE

cluck init

Creates a new coop workspace in the current directory, with a coop.yolk file and a .feed file for secrets..

Synopsis

cluck init [name] [--template T]

Description

Creates a new coop workspace in the current directory, with a coop.yolk file and a .feed file for secrets.

Options

FlagDescription
--template TStart from a template (web, api, worker)
--region RPick the home coop region
--forceOverwrite an existing coop.yolk

All commands also accept the global flags --coop, --json, --quiet, and --no-color, plus --help, which prints this page in a smaller font.

Example

$ cluck init orders --template api
✔ Created orders/coop.yolk
✔ Created orders/.feed (gitignored)
  Next: cd orders && cluck roost

Exit codes

0Success. A quiet cluck.
1The command ran but reported a problem, such as a failing check.
2Bad usage: a flag was missing or invalid.
3Authentication or permission error. See HEN-2001.

Used in guides

Common errors

Related commands