autorestic/docs/pages/cli/general.md

# General

## `-c, --config`

Specify the config file to be used (must use .yml as an extension).
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`

Run the CLI in CI Mode, which means there will be no interactivity, no colors and automatically sets the `--verbose` flag.

This can be useful when you want to run cron e.g. as all the output will be saved.

```bash
autorestic --ci backup -a
```

## `-v, --verbose`

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
```

## `--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
```
docs 2020-11-13 15:48:20 +01:00			`# General`

docs 2021-04-16 00:26:57 +02:00			## `-c, --config`
docs 2020-11-13 15:48:20 +01:00
DOC - Note on config filename extension Seems the config file can be located wherever needed but not using an extension or using an extension other than .yml causes the following error could not load config file Unsupported Config Type "" 2022-04-08 11:31:42 +02:00			`Specify the config file to be used (must use .yml as an extension).`
docs 2020-11-13 15:48:20 +01: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`

docs 2021-04-16 00:26:57 +02:00			Run the CLI in CI Mode, which means there will be no interactivity, no colors and automatically sets the `--verbose` flag.
docs 2020-11-13 15:48:20 +01:00
			`This can be useful when you want to run cron e.g. as all the output will be saved.`

			```bash
docs 2021-04-16 00:26:57 +02:00			`autorestic --ci backup -a`
			```

docs 2021-04-17 13:12:25 +02:00			## `-v, --verbose`
docs 2021-04-16 00:26:57 +02: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`
docs 2020-11-13 15:48:20 +01:00			```
docs 2021-04-21 09:41:14 +02:00
custom restic binary 2021-05-06 15:04:35 +02: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`
			```