autorestic/docs/pages/cli/general.md

45 lines
1.3 KiB
Markdown
Raw Normal View History

2020-11-13 14:48:20 +00:00
# General
2021-04-15 22:26:57 +00:00
## `-c, --config`
2020-11-13 14:48:20 +00:00
Specify the config file to be used (must use .yml as an extension).
2020-11-13 14:48:20 +00:00
If omitted `autorestic` will search for for a `.autorestic.yml` in the current directory and your home directory.
```bash
autorestic -c /path/to/my/config.yml
```
## `--ci`
2021-04-15 22:26:57 +00:00
Run the CLI in CI Mode, which means there will be no interactivity, no colors and automatically sets the `--verbose` flag.
2020-11-13 14:48:20 +00:00
This can be useful when you want to run cron e.g. as all the output will be saved.
```bash
2021-04-15 22:26:57 +00:00
autorestic --ci backup -a
```
2021-04-17 11:12:25 +00:00
## `-v, --verbose`
2021-04-15 22:26:57 +00:00
Verbose mode will show the output of the native restic commands that are otherwise not printed out. Useful for debugging or logging in automated tasks.
```bash
autorestic --verbose backup -a
2020-11-13 14:48:20 +00:00
```
2021-04-21 07:41:14 +00:00
2021-05-06 13:04:35 +00:00
## `--restic-bin`
With `--restic-bin` you can specify to run a specific restic binary. This can be useful if you want to [create a custom binary with root access that can be executed by any user](https://restic.readthedocs.io/en/stable/080_examples.html#full-backup-without-root).
```bash
autorestic --restic-bin /some/path/to/my/custom/restic/binary
```
## `--lockfile`
Specify the path for the [lockfile](../lockfile.md) used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
```bash
autorestic --lockfile /path/to/my/.autorestic.lock.yml
```