diff --git a/apps/vault/tools/vaultbackup-rs/README.md b/apps/vault/tools/vaultbackup-rs/README.md new file mode 100644 index 000000000..4950d0809 --- /dev/null +++ b/apps/vault/tools/vaultbackup-rs/README.md @@ -0,0 +1,66 @@ +# `vaultbackup-rs` + +A tool to backup/restore `vault` app storage to/from your computer. + +## Supported data + + - passwords + - TOTP tokens + +## Dependencies + +[`hidapi`](https://github.com/libusb/hidapi) is required for this tool to work. + +On Debian-based systems, it can be installed with `apt-get install libhidapi-dev`. + +On top of that, Linux systems need the following `udev` rules: + +```udev +SUBSYSTEM=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="5bf0", GROUP="plugdev", TAG+="uaccess" +SUBSYSTEM=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="3613", GROUP="plugdev", TAG+="uaccess" +``` + +Place them in `/etc/udev/rules.d/99-precursor-usb.rules`, and either reboot your system or reload `udev` rules with: + +``` +# udevadm control --reload-rules +``` + +`udev` rules aren't strictly required, they're there to allow you to communicate with Precursor without root privileges. + +If you prefer prefixing `sudo` to every `vaultbackup-rs` invocation, you're free to do so. + +## Usage + +``` +vaultbackup +A backup/restore tool for the Precursor vault app. + +USAGE: + vaultbackup-rs + +OPTIONS: + -h, --help Print help information + +SUBCOMMANDS: + backup Backup data from device + help Print this message or the help of the given subcommand(s) + restore Restore data to device +``` + +Using the tool is quite simple: + +``` +vaultbackup-rs +``` + +`ACTION` can either be `backup` or `restore`, while target specifies the data you want to act upon: + +| Target | Meaning | +|---|---| +|`password`|Act on passwords storage| +|`totp`|Act on TOTP storage| + +`PATH` specifies the path where `vaultbackup-rs` reads/writes data. + +The output format is JSON.