https://github.com/nils-werner/crestic
Configurable Restic Wrapper
https://github.com/nils-werner/crestic
Last synced: about 1 month ago
JSON representation
Configurable Restic Wrapper
- Host: GitHub
- URL: https://github.com/nils-werner/crestic
- Owner: nils-werner
- License: mit
- Created: 2019-12-17T09:14:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-18T13:41:02.000Z (about 1 month ago)
- Last Synced: 2025-04-19T01:49:36.626Z (about 1 month ago)
- Language: Python
- Homepage: https://nils-werner.github.io/crestic/
- Size: 159 KB
- Stars: 108
- Watchers: 6
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-restic - crestic - Configurable restic wrapper with support for profiles and environments (Wrappers)
- RAWR - Crestic - Configurable Restic Wrapper. ([Website](https://nils-werner.github.io/crestic/)) (Backups)
README
Crestic - configurable Restic
=============================
This is a slim configuration wrapper for [Restic](https://restic.readthedocs.io/), a pretty awesome backup tool.
Why? [Because restic is unfortunately still missing config files](https://github.com/restic/restic/issues/16).
Usage
-----
The goal of `crestic` is to make running `restic` easy, e.g. creating backups using
```Shell
crestic home backup
```
instead of running complex `restic` commands
```Shell
restic backup \
--repo sftp:your_server:my_computer.restic \
--password-file ~/.config/restic/password \
--exclude-file ~/.config/restic/excludes \
~
```
To achieve this, this tool does not try to be clever, it simply maps any *commandline options* for `restic` to a *key in an config file*:
```INI
[home]
repo: sftp:your_server:my_computer.restic
password-file: ~/.config/restic/password
[home.backup]
exclude-file: ~/.config/restic/excludes
_arguments: ~
```
More advanced usage examples can be found [in the docs](https://nils-werner.github.io/crestic/)