vacuum-tube/README.md

17 lines
746 B
Markdown
Raw Normal View History

2021-10-08 18:25:33 +00:00
<img src="https://meowbox.sapphic.pw/vacuum-tube-nobg.png" alt="Vacuum Tube logo" width="200" style="image-rendering: pixelated"/>
# Vacuum Tube
A small command line tool that displays information about your Borg backups.
![A screenshot of the config file and terminal output](https://i.imgur.com/do63AZK.png)
## Dependencies
- Borg
- Python 3.0+
## Usage
1. *Optional: create a [virtual environment](https://docs.python.org/3/library/venv.html) and run `source <venv>/bin/activate`*
2. Clone the respository: `git clone https://git.lain.faith/sorceress/vacuum-tube.git && cd vacuum-tube`
3. Install dependencies: `pip3 install -r requirements.txt`
4. Run: `python main.py`
5. Edit the newly created configuration file and run `main.py` again