garbage/README.md

68 lines
1.1 KiB
Markdown
Raw Normal View History

2019-11-27 01:04:04 +00:00
garbage
=======
2019-06-26 07:46:46 +00:00
2021-09-07 11:28:07 +00:00
[![Build Status](https://ci.mzhang.io/api/badges/michael/garbage/status.svg)](https://ci.mzhang.io/michael/garbage)
2019-12-05 07:36:45 +00:00
[![crates.io](https://img.shields.io/crates/v/garbage.svg)](https://crates.io/crates/garbage)
2019-06-26 07:46:46 +00:00
2020-03-06 05:55:48 +00:00
Rust ver of trash-cli.
2019-06-26 07:46:46 +00:00
2020-03-06 05:55:48 +00:00
* **Windows/Recycle Bin not supported**
2019-12-05 07:06:49 +00:00
2019-11-27 01:07:47 +00:00
Installation
------------
2021-01-29 02:40:21 +00:00
- [garbage](https://aur.archlinux.org/packages/garbage/) on AUR
2019-11-27 01:07:47 +00:00
```
cargo install garbage
```
2019-06-26 07:46:46 +00:00
Usage
-----
2020-03-06 05:55:48 +00:00
Run `garbage --help` to understand how it's used!
2019-06-26 07:46:46 +00:00
```
2020-03-06 05:55:48 +00:00
$ garbage put file1 file2 ...
2019-06-26 07:46:46 +00:00
2019-11-27 01:04:04 +00:00
$ garbage restore
2019-06-26 07:46:46 +00:00
[..interactive]
2019-11-27 01:04:04 +00:00
$ garbage list
2019-07-23 07:02:05 +00:00
2019-11-27 01:04:04 +00:00
$ garbage empty [days]
2019-06-26 07:46:46 +00:00
```
2019-12-05 07:36:45 +00:00
If you use a bash-ish shell, feel free to add this to your shell's rc file:
```sh
2020-03-06 05:55:48 +00:00
alias rm='garbage put' # Make sure garbage is in your path
2019-12-05 07:36:45 +00:00
```
Features
--------
- [x] Put
2020-03-06 05:55:48 +00:00
- [x] List
- [x] Restore
2019-12-05 07:36:45 +00:00
- [ ] Tests...
Spec Compliance
---------------
- [x] Picking a Trash Directory
- [x] Emptying
2020-05-27 21:37:12 +00:00
- [ ] Directory size cache (optional)
Issues
------
If you find a bug or are requesting a feature, file it here: https://todo.sr.ht/~iptq/garbage
2019-12-05 07:36:45 +00:00
2019-06-26 07:46:46 +00:00
About
-----
Author: Michael Zhang
2021-06-25 23:39:04 +00:00
License: GPLv3