Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oberblastmeister/trashy
a cli system trash manager, alternative to rm and trash-cli
https://github.com/oberblastmeister/trashy
cli file rm rust trash-cli trashcan
Last synced: 2 days ago
JSON representation
a cli system trash manager, alternative to rm and trash-cli
- Host: GitHub
- URL: https://github.com/oberblastmeister/trashy
- Owner: oberblastmeister
- License: apache-2.0
- Created: 2020-09-04T01:41:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-19T02:18:44.000Z (12 months ago)
- Last Synced: 2024-04-23T19:09:42.593Z (8 months ago)
- Topics: cli, file, rm, rust, trash-cli, trashcan
- Language: Rust
- Homepage:
- Size: 612 KB
- Stars: 302
- Watchers: 4
- Forks: 11
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust-tools - trashy - cli. (FileSystem)
README
# trashy
*trashy* is a simple, fast, and featureful alternative to *rm* and *trash-cli* written in rust.
Quick links:
- [Usage](#usage)
- [Installation](#installation)
## Demo
## Features
- easy to use, just run `trashy put PATH`
- recursive by default, without having the issues
- beautiful output
- colorized paths (similar to *fd*)
- cool tables
- very fast, and faster than trash-cli (see [benchmarks](#benchmarks))
- much safer than `rm -rf`
- intuitive syntax and fine grained control
- uses the system trash on both linux and windows
## Usage
### Trash a path
```bash
$ trashy first second third
```
This is just sugar for
```bash
$ trashy put first second third
```
### List items in the trash
```bash
$ trashy list
```
### Restore or empty some files
```bash
$ trashy restore first second
```
```bash
$ trashy empty first second third
```
The `restore` and `empty` subcommands both take very similar arguments and flags.
By default the arguments for `restore` and `empty` are interpreted as regular expressions.
Use the `-m` option to interpret them differently.
### Restore or empty all files
```bash
$ trashy restore --all
```
```bash
$ trashy empty --all
```
## Integrations
### fzf
Restore with fzf
```bash
trashy list | fzf --multi | awk '{$1=$1;print}' | rev | cut -d ' ' -f1 | rev | xargs trashy restore --match=exact --force
```
Empty with fzf
```bash
trashy list | fzf --multi | awk '{$1=$1;print}' | rev | cut -d ' ' -f1 | rev | xargs trashy empty --match=exact --force
```
## Installation
### Using cargo
```bash
cargo install trashy
```
### From Github Releases
Download the binary from Github Releases and put it in your `$PATH`.
### From the AUR
Use your favorite AUR helper.
```bash
paru -S trashy
```
### Using Nix
```bash
nix-env -i trashy
```
Or if you have flakes enabled:
```bash
nix profile install nixpkgs#trashy
```
## Benchmarks
These benchmarks are run on the rust compiler source in the `compiler/` directory.
The directory has about 2000 files. The benchmarks are run using [hyperfine](https://github.com/sharkdp/hyperfine).
Running `put` on each file in the `compiler/` directory recursively.
```
hyperfine -M 1 'fd -t f --threads 1 -x trash-put'
```
```
Time (abs ≡): 65.849 s [User: 54.383 s, System: 11.370 s]
```
Now with `trashy`
```
hyperfine -M 1 'fd -t f --threads 1 -x trashy put'
```
```
Time (abs ≡): 4.822 s [User: 2.014 s, System: 2.918 s]
```
`trashy` has practically zero startup time, while `trash-cli` has a large startup time because it is written in python. This difference in startup time causes massive speed differences when used in scripts. The benchmark shows that `trashy` is about 13 times faster!
Listing the previously trashed items
```
hyperfine 'trash-list'
```
```
Time (mean ± σ): 383.7 ms ± 10.5 ms [User: 321.8 ms, System: 59.4 ms]
Range (min … max): 375.9 ms … 412.0 ms 10 runs
```
```
hyperfine 'trashy list'
```
```
Time (mean ± σ): 178.3 ms ± 1.9 ms [User: 135.7 ms, System: 40.4 ms]
Range (min … max): 175.6 ms … 181.0 ms 16 runs
```
`trashy` is faster by more than 2 times.
## FAQ
### Is this supported on MacOS?
No, see this [issue](https://github.com/Byron/trash-rs/issues/8)
### Should I alias rm='trashy put'?
You should not. The alias will not be present on other systems and habits are really hard to break. An alternative is to alias `trashy put` to `rt` or `tp`.
## License
Copyright (c) 2020 Brian Shu
*trashy* is distributed under the terms of both the MIT license and the Apache License 2.0.
See the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT)