How to install the basmati crate // Lib.rs

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install basmati

It will make the basmati command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall basmati uninstalls.

Back to the crate overview.

Readme

Basmati is a cli command like utility to stream archives up and down, to and from AWS Glacier, AWS's cold storage offering. Cold storage means that when you want your files you have to send in a request to be fulfilled within 6 - 12 hours. The process is pretty tiresome as you need to download your archive within a certain time frame of having initiated the download job. Basmati makes it easy by showing your inventory in a TUI application, polling Glacier until the job is ready and completed and calculating all the annoying treehashes to successfully upload archives.

Environment and setup

The tool assumes your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are in your environment already. There is currently no way to pass those in as command line arguments.

Packaging

Basmati is currently available as a crate or as Nix flake.

# crate
cargo install basmati

# get the flake
{
  inputs = {
    ...
    basmati.url = "github:vhsconnect/basmati";

};

# add to your packages attribute set
{pkgs, inputs, ...} :{
    environment.systemPackages = [
        inputs.basmati.packages.${pkgs.system}.default
    ]

};

USAGE

Usage: basmati [OPTIONS] [COMMAND]

Commands:
  create
  upload
  inventory
  download
  help       Print this message or the help of the given subcommand(s)

Options:
  -d, --debug...
  -h, --help      Print help
  -V, --version   Print version

create

Create a new vault

Create a vault by supplying a name

Usage: basmati create --vault-name <VAULT_NAME>

Options:
  -v, --vault-name <VAULT_NAME>  
  -h, --help                     Print help

upload

Upload an archive or file

Upload an archive at path to a particular vault with a particular description

Usage: basmati upload --file-path <FILE_PATH> --vault-name <VAULT_NAME> --description <DESCRIPTION>

Options:
  -f, --file-path <FILE_PATH>      
  -v, --vault-name <VAULT_NAME>    
  -d, --description <DESCRIPTION>  
  -h, --help                       Print help

download

Download an archive by specifying a vault and path. You must have run inventory command first to download a ledger of your assets

Download a job

Usage: basmati download [OPTIONS]

Options:
  -v, --vault-name <VAULT_NAME>  Required if not finishing pending jobs - you will be prompted to select an archive from a list. List will be empty if you have not queried for inventory first
  -o, --output-as <OUTPUT_AS>    Optional: Where to write out the archive to
  -p, --pending                  Pass this option to finish a job you started earlier
  -h, --help

inventory

Download an invenory list for a specific vault

Get the inventory of a particular vault

Usage: basmati inventory --vault-name <VAULT_NAME>

Options:
  -v, --vault-name <VAULT_NAME>  
  -h, --help                     Print help

delete-archive

Delete an archive from a vault

Delete a particular archive by selecting it from an archive

Usage: basmati delete-archive --vault-name <VAULT_NAME>

Options:
  -v, --vault-name <VAULT_NAME>  
  -h, --help                     Print help

list-vaults

List all vaults for current account

Usage: basmati list-vaults

Options:
  -h, --help  Print help

TODO

better sanitization and cleanup for cache and TMP
implement better signal interupt handling in tui mode
provide binaries for major platforms