mirror of
https://git.sr.ht/~nixgoat/vento
synced 2024-11-16 12:02:49 +00:00
Lux Aliaga
86d3a00f02
After the situation with the developers of Gitea wanting to privatize their project and experiment with DAOs, I've decided to finally switch to Sourcehut. The opinions on this forge are generally favorable, so I'm hoping this will be for the best.
88 lines
2 KiB
Markdown
88 lines
2 KiB
Markdown
|
|
|
|
[](https://crates.io/crates/vento)
|
|
[](https://crates.io/crates/vento)
|
|
[](https://git.sr.ht/~nixgoat/vento/tree/master/item/LICENSE.md)
|
|
|
|
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](https://github.com/mothdotmonster/inventory).
|
|
|
|
[](https://asciinema.org/a/524454)
|
|
|
|
## Installation
|
|
|
|
### 1) Cargo (Recommended)
|
|
|
|
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](https://moth.monster/) for the original concept
|
|
- [jo!](https://sr.ht/~j0lol/) for helping me with Rust concepts!
|