cupcakearmy/autorestic
1
0
Fork 0
mirror of https://github.com/cupcakearmy/autorestic.git synced 2025-09-02 00:30:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
cupcakearmy
2021-04-16 00:26:57 +02:00
parent a45eee6009
commit 952334fecb
12 changed files with 50 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/markdown/cli/backup.md
View File

@@ -7,7 +7,11 @@ autorestic backup [-l, --location] [-a, --all]
Performs a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
```bash
autorestic backup -l my-location
# All
autorestic backup -a
# Some
autorestic backup -l foo -l bar
```
> :ToCPrevNext

8
docs/markdown/cli/check.md
View File

@@ -1,15 +1,11 @@
# Check
```bash
autorestic check [-b, --backend] [-a, --all]
autorestic check
```
Cheks if one or more backend are configured properly and initializes them if they are not already.
Checks locations and backends are configured properly and initializes them if they are not already.
This is mostly an internal command, but useful to verify if a backend is configured correctly.
```bash
autorestic check -b my-backend
```
> :ToCPrevNext

6
docs/markdown/cli/forget.md
View File

@@ -1,11 +1,13 @@
# Forget
```bash
autorestic forget [-l, --location] [-a, --all] [--dry-run]
autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune]
```
This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/locations/forget)
This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget)
The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
The `--prune` flag will also [prune the data](https://restic.readthedocs.io/en/latest/060_forget.html#removing-backup-snapshots). This is a costly operation that can take longer, however it will free up the actual space.
> :ToCPrevNext

23
docs/markdown/cli/general.md
View File

@@ -1,14 +1,6 @@
# General
## `--version`
Prints the current version
```bash
autorestic --version
```
## `--c, --config`
## `-c, --config`
Specify the config file to be used.
If omitted `autorestic` will search for for a `.autorestic.yml` in the current directory and your home directory.
@@ -19,11 +11,18 @@ autorestic -c /path/to/my/config.yml
## `--ci`
> Available since version 0.22
Run the CLI in CI Mode, which means there will be no interactivity, no colors and automatically sets the `--verbose` flag.
Run the CLI in CI Mode, which means there will be no interactivity.
This can be useful when you want to run cron e.g. as all the output will be saved.
```bash
autorestic --ci
autorestic --ci backup -a
```
## `--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
```