vacuum-tube/README.md

23 lines
969 B
Markdown
Raw Permalink 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
2021-10-17 23:31:48 +00:00
1. Clone the respository: `git clone https://git.lain.faith/sorceress/vacuum-tube.git && cd vacuum-tube`
2. Run `sudo pip install .` *(Or, without `sudo` if you wish to install it into `~/.local/bin/`)*
3. Run `vacuum-tube`
5. Edit the newly created configuration file and run `vacuum-tube` again
## Troubleshooting
- ### vacuum-tube: command not found
If you installed the package locally, your installation directory may not be in `$PATH`.
You can add it with `export PATH="/some/directory:$PATH"` in your `.bashrc`/`.zshrc`/etc file.
- ### No module named setuptools
`pip install setuptools`