## pyre

Pyre: disaster-recovery backup as a service

### Synopsis

pyre is the command-line client for Pyre. It manages volumes, restore
points, views and appliances for a customer, and hubs and users for an
operator. Everything it does goes through the control-plane API, so it
works the same against api.pyredata.io and a self-hosted Pyre manager.

Getting started:
  1. Create an API token on the dashboard (Account > API tokens).
  2. pyre auth login            (paste the token when asked)
  3. pyre volume list

Scripting: add -o json for machine-readable output and --yes to skip
confirmations. Exit codes: 0 ok, 1 error, 2 usage, 3 not authorised,
4 not found, 5 refused (a confirmation was needed and --yes was absent).

Environment: PYRE_TOKEN, PYRE_API_BASE, PYRE_PROFILE, PYRE_CA_CERT,
PYRE_INSECURE=1, PYRE_CONFIG_DIR override the config file.

### Examples

```
  pyre auth login
  pyre volume list -o json
  pyre volume create backups --size 100GB --type nfs
  pyre restore-points list backups --since 7d
  pyre restore backups 2026-09-20T08:00:00Z --as backups-before-upgrade
  pyre update
```

### Options

```
      --api string       API base URL (default from the profile, or https://api.pyredata.io)
      --ca-cert string   PEM file with an extra CA to trust (self-hosted managers)
  -h, --help             help for pyre
      --insecure         skip TLS certificate verification (lab use only)
  -o, --output string    output format: table, json or plain (default "table")
      --profile string   config profile to use (see: pyre config)
  -q, --quiet            print results only, no notices
      --token string     API token (default from the profile; prefer PYRE_TOKEN in scripts)
  -y, --yes              answer yes to every confirmation (for scripts)
```

### SEE ALSO

* [pyre account](pyre_account.md)	 - Your account: summary, closing it, reclaiming a closed one's data
* [pyre admin](pyre_admin.md)	 - Operator commands: hubs, users, tenants
* [pyre appliance](pyre_appliance.md)	 - The appliance that serves a volume on your computer
* [pyre auth](pyre_auth.md)	 - Log in, log out, and manage API tokens
* [pyre batch](pyre_batch.md)	 - Run many pyre commands from a file or stdin, one per line
* [pyre completion](pyre_completion.md)	 - Print a shell completion script
* [pyre config](pyre_config.md)	 - Show and edit the config file and its profiles
* [pyre export](pyre_export.md)	 - A copy of a volume: downloaded from a link, or on tape or disc; opened with your key
* [pyre history](pyre_history.md)	 - Show or set a volume's retention policy
* [pyre recovery](pyre_recovery.md)	 - Recovery volumes made by `pyre restore`: list, promote, delete
* [pyre restore](pyre_restore.md)	 - Restore a volume to a point in time, as a new volume
* [pyre restore-points](pyre_restore-points.md)	 - List the points in time a volume can be restored to
* [pyre snapshot](pyre_snapshot.md)	 - Mark a named moment that retention never thins out
* [pyre store](pyre_store.md)	 - Your own S3 stores (bring your own storage)
* [pyre uninstall](pyre_uninstall.md)	 - Remove pyre from this computer
* [pyre update](pyre_update.md)	 - Update pyre to the newest release
* [pyre version](pyre_version.md)	 - Show the CLI version (and, with --check, the newest release and the API build)
* [pyre view](pyre_view.md)	 - Read-only views of a volume at a moment in time
* [pyre volume](pyre_volume.md)	 - Create, list, resize and delete volumes