Docs / CLI Reference
CLI reference
Every command the fieldwick CLI exposes, grouped by what you are trying to do. Pass --help to any command for the full flag list and examples.
Auth
Create an account, authenticate, and sign out.
| Command | Flags | What it does |
|---|---|---|
signup <email> | --team-name, --api, --force | Create a new Fieldwick account and write credentials to disk. Pair with --force to overwrite an existing credentials file. |
login | --token, --browser, --paste, --no-browser, --api-base | Authenticate with Fieldwick. Default flow opens a device-auth URL in the browser and polls for approval. Use --token for non-interactive CI environments. Use --browser if you are already signed in to the dashboard. |
logout | - | Remove the stored bearer token and API base URL from disk. Does not revoke the token server-side. |
Deploy
Initialize a project, trigger builds, and manage deployment history.
| Command | Flags | What it does |
|---|---|---|
init | --dir, --force, --dry-run | Detect your project language and framework, then write a fieldwick.json into the current directory. Use --dry-run to preview the output without writing. Use --force to overwrite an existing file. |
deploy <service-id> | --commit, --branch, --wait, --tail-logs, --timeout, --poll, --json | Trigger a new deployment for a service. By default the command returns immediately after queuing the job. Add --wait to block until the deployment reaches a terminal state. --tail-logs streams build output alongside the status poll (implies --wait). |
deployments list <service-id> | --json | List recent deployments for a service. |
deployments show <deployment-id> | --json | Show details for a single deployment. |
deployments inspect <deployment-id> | --json | Verbose deep-dive on a single deployment, including the full events timeline. |
deployments rollback <deployment-id> | --json | Roll back a service to a previous deployment. The specified deployment ID becomes the active allocation. |
deployments cancel <deployment-id> | --json | Cancel an in-flight deployment. Leaves the prior version in place. |
deployments wait <deployment-id> | --timeout, --poll, --json | Block until a deployment reaches a terminal state. Exits 0 for success, 1 for failure, 124 for timeout. |
deployments diff <id-1> <id-2> | --json | Compare two deployments side by side. |
Inspect
Read service state, stream logs, and check platform health.
| Command | Flags | What it does |
|---|---|---|
services | --project, --limit, --cursor, --json | List all services the authenticated user can see. Filter to a project with --project. |
services show <id> | --json | Show details for a single service. |
services info <service-id> | --json | Show a rich summary for a service, including current metrics. |
services logs <id> | --tail, --since, --lines, --filter, --json | Fetch or stream runtime logs for a service. Default mode returns the last 100 lines and exits. Use --tail to stream new lines until Ctrl-C. |
services scale <id> | --replicas, --cpu, --mem, --json | Scale a service without triggering a new deploy. Adjusts replica count, CPU limit (mhz), or memory limit (mb) in place. |
services restart <id-or-name> | --json | Restart a service in place without rebuilding the image. Useful for clearing runtime state. |
services suspend <id-or-name> | --json | Suspend a service. Tears down allocations and stops billing. Use services unsuspend to restore. |
services unsuspend <id-or-name> | --json | Restore a suspended service. Re-attaches billing and restarts the allocation. |
teams | - | Manage Fieldwick teams. Parent command - see subcommands below. |
teams list | --cursor, --json | List all teams the authenticated user belongs to. |
teams show <id> | --json | Show details for a single team. |
teams current | - | Print the active team that subsequent CLI commands will operate against. |
status | --json | Show the Fieldwick platform health summary: API, builder, scheduler, and ingress status. |
The CLI has additional commands beyond what is listed here: cron scheduling, domain management, environment variable management, and more. Run fieldwick --help to see every available command. The source is at github.com/mrdorianh/fieldwick.