CLI reference · Docs

Install

$ curl -fsSL https://get.fwoop.dev/cli | sh

The CLI is the same fwoop binary the agent uses. On a laptop, sign in with fwoop login; in CI, set FWOOP_TOKEN to an API token instead.

Option	Description
`--project <name>`	Project to act on. Defaults to the one set with `fwoop use`.
`--json`	Machine-readable output
`--yes`	Skip confirmation prompts

Command	Description
`fwoop login`	Sign in through the browser
`fwoop logout`	Remove local credentials
`fwoop use <project>`	Set the default project
`fwoop status`	Workspace, project and fleet health at a glance

Command	Description
`fwoop servers list`	Servers with status, labels and agent version
`fwoop servers label <server> key=value…`	Add or change labels (`key-` removes one)
`fwoop servers remove <server>`	Disconnect a server

Command	Description
`fwoop deploy <service> [--target] [--wait]`	Create a release from `compose.yaml` and roll it out
`fwoop releases <service>`	Release history
`fwoop rollback <service> [release]`	Roll back to a release, the previous one by default
`fwoop logs <service> [-f] [--server]`	Stream container logs
`fwoop restart <service>`	Restart containers one server at a time

Command	Description
`fwoop jobs list`	Jobs with schedule, target and last result
`fwoop jobs create <name> --schedule --target --command`	Create a job
`fwoop jobs run <job>`	Run now, outside the schedule
`fwoop jobs history <job>`	Recent runs
`fwoop jobs import --server <server>`	Turn a server’s crontabs into jobs

Command	Description
`fwoop backups list`	Backup plans and their last run
`fwoop backups run <plan>`	Take a snapshot now
`fwoop backups snapshots <plan>`	List snapshots
`fwoop backups restore <plan> <snapshot> [--to] [--path]`	Restore all or part of a snapshot

Command	Description
`fwoop secrets list --env <env>`	Names, versions and where they’re used
`fwoop secrets set <NAME> --env <env>`	Set a value (prompted, never echoed)
`fwoop secrets unset <NAME> --env <env>`	Remove a secret
`fwoop secrets import <file> --env <env>`	Import a `.env` file
`fwoop secrets diff <env> <from> <to>`	Compare two versions

Command	Description
`fwoop apply [-f fwoop.yaml]`	Show a diff and apply it
`fwoop audit [--since] [--format]`	Export the audit log
`fwoop maintenance start --target --for`	Silence alerts during planned work

Command	Description
`fwoop agent status`	Connection, version and labels
`fwoop agent pin` / `unpin`	Stop or resume automatic updates
`fwoop agent uninstall`	Remove the agent

0 success · 1 error · 2 invalid usage · 3 a rollout or job failed (with --wait) · 4 not signed in.