1# Backup Command
2
3Manage backups for database attachments.
4
5## gordon backup
6
7```bash
8gordon backup <subcommand>
9```
10
11Subcommands:
12
13- `list [domain]` - List backups globally or for one domain
14- `run <domain> [--db <name>]` - Trigger an immediate backup
15- `detect <domain>` - Detect supported databases for a domain
16- `status` - Show backup status across domains
17
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>`.
21
22In normal usage, configure remotes once (`gordon remotes ...`) and run backup commands without per-command remote flags.
23
24## Examples
25
26```bash
27# List all backups
28gordon backup list
29
30# List backups for one domain
31gordon backup list app.example.com
32
33# Trigger backup (auto-detect when exactly one DB attachment exists)
34gordon backup run app.example.com
35
36# Trigger backup for specific attachment name
37gordon backup run app.example.com --db postgres
38
39# Detect DB attachments
40gordon backup detect app.example.com
41
42# Status summary
43gordon backup status
44```
45
46## Output Columns
47
48### list
49
50```text
51<domain>\t<db>\t<status>\t<started_at>\t<backup_id>
52```
53
54### detect
55
56```text
57<name>\t<type>\t<host>\t<port>\t<image>
58```
59
60### status
61
62```text
63<domain>\t<db>\t<status>\t<started_at>
64```
65
66### run
67
68```text
69<domain>\t<db>\t<status>\t<started_at>\t<backup_id>\t<size_bytes>
70```
71
72## Required Permissions
73
74- Read operations (`list`, `status`, `detect`) require `admin:status:read`.
75- `run` requires `admin:config:write`.
76
77## Related
78
79- [CLI Commands](./index.md)
80- [Backups Configuration](../config/backups.md)