CLI — Shoal

Terminal

npm install -D @shoal/cli

Terminal

pnpm add -D @shoal/cli

Terminal

yarn add -D @shoal/cli

Terminal

bun add -d @shoal/cli

Authenticate once; the token is stored in your OS keychain.

Terminal

npx shoal login

Commands

`shoal flags`

Terminal

shoal flags list [--env <env>] [--stale]
shoal flags create <key> --type boolean|string|number|json
shoal flags toggle <key> --env <env> --on|--off
shoal flags copy <key> --from <env> --to <env>
shoal flags delete <key>

`shoal rollout`

Terminal

shoal rollout <key> --env <env> --percent <0-100>
shoal rollout <key> --env <env> --schedule "5%:now, 50%:+2d, 100%:+7d"
shoal rollout <key> --env <env> --pause | --resume

`shoal generate`

Writes a TypeScript declaration with every flag key and its variation type.

Option	Default	Description
`--out`	`shoal.d.ts`	Output file
`--project`	from `shoal.yaml`	Project id
`--check`	`false`	Exit 1 if the file is out of date (for CI)

`shoal keys`

Terminal

shoal keys list --env production
shoal keys rotate sk --env production

Global options

--project <id> — override the project from shoal.yaml
--json — machine-readable output
--yes — skip confirmation prompts (CI)