Getting Started
Quickstart
Archive and query your first database backup in under 5 minutes.
This guide walks you through creating your first ColdPlane backup and running a query against it.
1. Install the CLI
curl -fsSL https://get.coldplane.com | sh2. Authenticate
coldplane auth set-key --key <your-api-key>You can generate an API key from the ColdPlane Dashboard.
3. Create a Backup
coldplane backup create \
--db-url "postgres://user:pass@host:5432/mydb" \
--tables "users,orders"4. Query Your Data
coldplane query run \
--backup-id <backup-id> \
--table users \
--sql "SELECT count(*) FROM users"You can find your backup ID with coldplane backup list.
Queries run directly against cold storage. No rehydration or restore step is needed.