Install the CLI with the installation guide, then run cluck doctor. Every command supports --help.
$ cluck <command> [options]
$ cluck --helpcommand
cluck install
Installs a product, SDK, or plugin from the flock into the active coop.
command
cluck init
Creates a new coop workspace in the current directory, with a coop.yolk file and a .feed file for secrets..
command
cluck login
Authenticates the CLI.
command
cluck logout
Removes local credentials.
command
cluck hatch
Generates a new project from a Hatchback template.
command
cluck deploy
Deploys the current project to HenHouse.
command
cluck rollback
Returns the service to a previous version.
command
cluck status
Shows the health of the active coop: services, hens (instances), recent deploys, and any open incidents..
command
cluck scratch
Tails logs for a service.
command
cluck peck
Sends an authenticated request to the Pollosoft API.
command
cluck forage
Searches the registry for packages, templates, and plugins.
command
cluck feed
Manages secrets and environment variables for the active coop.
command
cluck candle
Runs data-quality checks against your datasets.
command
cluck molt
Runs database schema migrations.
command
cluck roost
Starts a local development server with hot reload.
command
cluck crow
Sends a notification to a channel.
command
cluck flock
Manages teams (flocks) and their permissions.
command
cluck coop
Manages coops, which are workspaces tied to a region.
command
cluck perch
Deploys code to Perch Edge locations around the world, so your users receive responses from the nearest perch..
command
cluck incubate
Spins up a temporary staging environment from the current branch.
command
cluck brood
Configures autoscaling for a service.
command
cluck fence
Manages firewall rules for the coop.
command
cluck fox
Runs a security scan against your coop configuration, code, and dependencies.
command
cluck nest
Runs containers on NestKube.
command
cluck egg
Builds and publishes artifacts (eggs).
command
cluck count
Shows usage and spending by service, tag, or coop.
command
cluck preen
Formats Cluck and YolkML files.
command
cluck config
Reads and writes CLI and coop configuration.
command
cluck doctor
Diagnoses problems with your install, network, credentials, and project.
command
cluck update
Updates the CLI to the latest release.
command
cluck webhook
Manages webhook endpoints.
command
cluck backup
Creates, lists, and restores backups.
command
cluck pilot
Brings PeckPilot into your terminal.