auberge 0.14.25

CLI tool for managing self-hosted infrastructure with Ansible
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# auberge

CLI for self-hosted infrastructure management.

```bash
auberge [GLOBAL OPTIONS] <COMMAND>
```

## Global options

| Option          | Description                                                                                       |
| --------------- | ------------------------------------------------------------------------------------------------- |
| `-v, --verbose` | Stream subprocess output (kept on failure, dimmed on success)                                     |
| `-q, --quiet`   | Suppress chrome on stderr (errors and stdout data unchanged); mutually exclusive with `--verbose` |
| `--no-color`    | Disable colored output (or set `NO_COLOR` env var)                                                |
| `-h, --help`    | Print help                                                                                        |
| `-V, --version` | Print version                                                                                     |

## Commands

| Command                                             | Alias | Purpose                                                  |
| --------------------------------------------------- | ----- | -------------------------------------------------------- |
| [deploy](cli-reference/deploy.md)                   | `dp`  | Deploy apps with auto-hardening                          |
| [versions](cli-reference/versions.md)               | `v`   | Report declared App and Tool Versions and upstream drift |
| [ansible](cli-reference/ansible/run.md)             | `a`   | Run Ansible playbooks                                    |
| [backup](cli-reference/backup/create.md)            | `b`   | Backup / restore / push / prune / verify                 |
| [dns](cli-reference/dns/list.md)                    | `d`   | Cloudflare DNS management                                |
| [host](cli-reference/host/add.md)                   | `h`   | Manage `hosts.toml`                                      |
| [ssh](cli-reference/ssh/keygen.md)                  | `ss`  | SSH key generation and deployment                        |
| [sync](cli-reference/sync/music.md)                 | `sy`  | rsync media to the VPS                                   |
| [headscale](cli-reference/headscale/add-user.md)    | `hs`  | Headscale users and nodes                                |
| [bichon](cli-reference/bichon/reconcile-folders.md) | —     | Bichon folder reconciliation                             |
| [config](cli-reference/config/overview.md)          | `c`   | Manage `config.toml`                                     |
| [select](cli-reference/select/host.md)              | `se`  | Interactive host / playbook pickers                      |
| [completions](cli-reference/completions.md)         | —     | Generate shell completion script                         |

## Files

| Purpose  | Path                              |
| -------- | --------------------------------- |
| Hosts    | `~/.config/auberge/hosts.toml`    |
| Config   | `~/.config/auberge/config.toml`   |
| Backups  | `~/.local/share/auberge/backups/` |
| SSH keys | `~/.ssh/identities/`              |

See [Configuration](configuration/hosts.md) for details on the config files.

## Examples

```bash
auberge host add my-vps 203.0.113.10
auberge deploy --all --host my-vps
auberge backup create --host my-vps
auberge dns list
```