Reference
CLI reference
Every pier command in the five help groups, with the global flags
Generated from the CLI's own command tree, so it cannot disagree with pier --help.
One page per top-level command; subcommands are sections on that page. The whole
reference on one page: all commands.
Global flags
| Flag | Value | Default | Description |
|---|---|---|---|
-v, --version | Print version | ||
-j, --json | Output as JSON | ||
--no-color | Disable colored output (env NO_COLOR) | ||
-w, --workspace | STRING | Override default workspace (name or ID) | |
-p, --project | STRING | Override default project (name, slug, or ID) (env PIER_PROJECT) | |
-e, --env | STRING | Target this environment for this command only (slug); use 'pier use' to switch | |
--profile | STRING | Use a named session profile for this invocation (e.g. local, dev) (env PIER_PROFILE) | |
--no-state | Ignore saved selections, always prompt |
Inspect the environment
| Command | Does |
|---|---|
pier status | Project state, resource counts, config drift |
pier logs | Read or follow logs for an app, a Postgres, or the whole environment |
pier events | Show or watch events for a resource, the environment, the project or the workspace |
pier monitor | Monitor a resource or the whole environment: live snapshot, --range summary, --metric drill-down |
pier deploys | Deploy history (apps + sites), incl. build logs |
pier ls | What's in the environment; a kind (apps, sites, pg, buckets, volumes, domains) narrows it |
pier info | One resource in full: an app or site with its targets, one target, a Postgres, bucket, volume or domain |
Change the environment
| Command | Does |
|---|---|
pier apply | Converge pier.yaml: add, set and remove resources — never rolls a workload |
pier deploy | Build and roll changed apps and sites (implies apply) |
pier add | Add a resource |
pier set | Change a resource's config |
pier rm | Remove a resource |
pier trash | Removed resources in their recovery window: list, restore, purge |
pier copy | Copy a resource to another environment |
pier rename | Rename a resource in place (non-destructive) |
pier promote | Make a target the primary of its app or site |
pier restart | Restart an app or a Postgres instance |
pier rollback | Roll an app or site back to a previous deploy |
pier pause | Pause a resource, environment, project or workspace (recoverable) |
pier resume | Resume a paused resource, environment, project or workspace |
Connect & data
| Command | Does |
|---|---|
pier ssh | Open a shell in a running app |
pier psql | Open a psql shell to a Postgres instance |
pier vars | Environment variables |
pier routes | Site routing rules |
pier pg | Postgres tools |
pier objects | Bucket objects (data plane) |
pier snapshots | Volume snapshots |
pier backups | Postgres backups |
pier github | GitHub push-to-deploy |
pier dev | Run the current environment locally (docker) |
Project & scope
| Command | Does |
|---|---|
pier config | pier.yaml lifecycle: init, sync, diff, validate |
pier use | Switch the active environment |
pier projects | Projects: list, add, inspect, remove, pause, switch |
pier environments | Environments: list, add, pause (switch with 'pier use') |
pier workspaces | Workspaces: switch, pause, resume |
CLI & account
| Command | Does |
|---|---|
pier login | Authenticate with the controller |
pier logout | Log out and clear session |
pier whoami | Show current user |
pier profiles | Session profiles (one login per controller) |
pier billing | Billing state and overage cap |
pier ssh-key | Generate SSH certificate for shell access |
pier upgrade | Upgrade the CLI to the latest version |
pier uninstall | Uninstall the Pier CLI and remove all data |