docs(cli): clarify backup run db auto-selection
- commit
- ca6db0b9696882d34e3773f6e0a60654dc408c74
- author
- brice · · 2026-02-07 16:21 UTC
- parent
- a4f03d1
- signature
- unsigned
1 file · +3 -1
M docs/cli/backup.md +3 -1
| @@ -16,6 +16,8 @@ Subcommands: | |||
| 16 | 16 | - `status` - Show backup status across domains | |
| 17 | 17 | ||
| 18 | 18 | > **Note:** Backup commands currently require remote mode (`--remote` + `--token`, or configured remotes). | |
| 19 | + | > | |
| 20 | + | > `gordon backup run <domain>` auto-selects the database only when exactly one supported DB attachment is detected. If multiple DB attachments are present, pass `--db <name>`. | |
| 19 | 21 | ||
| 20 | 22 | In normal usage, configure remotes once (`gordon remotes ...`) and run backup commands without per-command remote flags. | |
| 21 | 23 | ||
| @@ -28,7 +30,7 @@ gordon backup list | |||
| 28 | 30 | # List backups for one domain | |
| 29 | 31 | gordon backup list app.example.com | |
| 30 | 32 | ||
| 31 | - | # Trigger backup (auto-detect database) | |
| 33 | + | # Trigger backup (auto-detect when exactly one DB attachment exists) | |
| 32 | 34 | gordon backup run app.example.com | |
| 33 | 35 | ||
| 34 | 36 | # Trigger backup for specific attachment name | |
| @@ -16,6 +16,8 @@ Subcommands: | |||||
| 16 | - `status` - Show backup status across domains | 16 | - `status` - Show backup status across domains | ||
| 17 | 17 | ||||
| 18 | > **Note:** Backup commands currently require remote mode (`--remote` + `--token`, or configured remotes). | 18 | > **Note:** Backup commands currently require remote mode (`--remote` + `--token`, or configured remotes). | ||
| 19 | + | > | |||
| 20 | + | > `gordon backup run <domain>` auto-selects the database only when exactly one supported DB attachment is detected. If multiple DB attachments are present, pass `--db <name>`. | |||
| 19 | 21 | ||||
| 20 | In normal usage, configure remotes once (`gordon remotes ...`) and run backup commands without per-command remote flags. | 22 | In normal usage, configure remotes once (`gordon remotes ...`) and run backup commands without per-command remote flags. | ||
| 21 | 23 | ||||
| @@ -28,7 +30,7 @@ gordon backup list | |||||
| 28 | # List backups for one domain | 30 | # List backups for one domain | ||
| 29 | gordon backup list app.example.com | 31 | gordon backup list app.example.com | ||
| 30 | 32 | ||||
| 31 | - | # Trigger backup (auto-detect database) | 33 | + | # Trigger backup (auto-detect when exactly one DB attachment exists) |
| 32 | gordon backup run app.example.com | 34 | gordon backup run app.example.com | ||
| 33 | 35 | ||||
| 34 | # Trigger backup for specific attachment name | 36 | # Trigger backup for specific attachment name | ||