Inventory management for the CLI - original concept by chesapeake
Go to file
Lux Aliaga 75fb04d674
help: Document the archiving flags
The only caveat is the limitations of the man library will not
allow me to write more in-depth documentation of the new flags. Maybe if
I go through refactoring the binary side using clap this will be easier.
2023-02-19 13:30:48 -03:00
assets readme: Add logo 2022-09-18 01:43:49 -03:00
src help: Document the archiving flags 2023-02-19 13:30:48 -03:00
.gitignore fixup! vento: Imported changes to Git 2022-09-14 09:41:06 -03:00
Cargo.lock archive: Add inventory exporting 2023-02-17 02:07:28 -03:00
Cargo.toml archive: Add inventory exporting 2023-02-17 02:07:28 -03:00
LICENSE.md vento: Licensed under GPLv3 2022-09-14 17:01:37 -03:00
Makefile.toml makefile: Disallow macOS from installing manpages. 2022-09-28 15:01:43 -03:00
README.md project: Sourcehut migration 2022-11-16 17:19:41 -03:00
build.rs help: Document the archiving flags 2023-02-19 13:30:48 -03:00

README.md

Vento

Latest version Downloads Licensed under GPLv3

Vento is a utility which allows you to manage your files as if you're playing an old text adventure. It's made in Rust and originally inspired by Chesapeake's Inventory.

asciicast

Installation

Make sure Rust is installed, along with cargo, Rust's package manager.

$ cargo install vento

2) Manually

Clone the repository using git.

$ git clone https://git.sr.ht/~nixgoat/vento && cd vento

2.a) cargo-make

This install method additionally installs the manpages for Vento. Make sure Rust, cargo and cargo-make are installed.

$ cargo make install

2.b) Cargo

Make sure Rust is installed, along with cargo, Rust's package manager.

$ cargo install --path .

Quick Start

After installing, run:

$ vento -i

This will create a .vento folder in your home directory, which will store your inventories. Some basic commands include:

// listing files in the currently active inventory
$ vento

// switching inventory slots
$ vento -c

// undoing last action
$ vento -u

// taking a file or directory
$ take <file|directory>

// dropping a file or directory
$ drop <file|directory> [destination]

For additional documentation, you can check the documentation for each command by running the following.

$ (command) -h

Or, if Vento was installed through cargo-make, check the manpages by running:

$ man (command)

Credits

  • Chesapeake for the original concept
  • jo! for helping me with Rust concepts!