koki-develop/gotrash

# gotrash

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/koki-develop/gotrash)](https://github.com/koki-develop/gotrash/releases/latest)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/koki-develop/gotrash/ci.yml?logo=github)](https://github.com/koki-develop/gotrash/actions/workflows/ci.yml)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/koki-develop/gotrash?style=flat&logo=codeclimate)](https://codeclimate.com/github/koki-develop/gotrash/maintainability)
[![Go Report Card](https://goreportcard.com/badge/github.com/koki-develop/gotrash)](https://goreportcard.com/report/github.com/koki-develop/gotrash)
[![LICENSE](https://img.shields.io/github/license/koki-develop/gotrash)](./LICENSE)

rm alternative written in Go.

- [Installation](#installation)
- [Usage](#usage)
  - [`put`](#gotrash-put)
  - [`list`](#gotrash-list)
  - [`restore`](#gotrash-restore)
  - [`clear`](#gotrash-clear)
- [LICENSE](#license)

## Installation

### Homebrew

```console
$ brew install koki-develop/tap/gotrash
```

### `go install`

```console
$ go install github.com/koki-develop/gotrash@latest
```

### Releases

Download the binary from the [releases page](https://github.com/koki-develop/gotrash/releases/latest).

## Usage

```console
$ gotrash --help
rm alternative written in Go.

Usage:
  gotrash [command]

Available Commands:
  clear       Clear all trashed files or directories
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  list        List trashed flies or directories
  put         Trash files or directories
  restore     Restore trashed files or directories

Flags:
  -h, --help      help for gotrash
  -v, --version   version for gotrash

Use "gotrash [command] --help" for more information about a command.
```

### `gotrash put`

`gotrash put` trashes files or directories.

![](./docs/put.gif)

Files and directories trashed by `gotrash put` are not deleted, but placed in the trash can ( `$GOTRASH_ROOT/can` ) .  
The `$GOTRASH_ROOT` environment variable ( default: `$HOME/.gotrash` ) can be rewritten to customize the trash can path.

### `gotrash list`

Alias: `gotrash ls`

Files and directories in the trash can can be viewed with `gotrash list`.

```console
$ gotrash list
```

![](./docs/list.gif)

### `gotrash restore`

Alias: `gotrash rs`

Trashed files and directories can be restored with `gotrash restore`.  
Check the index with `gotrash list` and pass it.

![](./docs/restore.gif)

If you execute without specifying indexes, fuzzy finder will start.  
You can use the tab key to select multiple files or directories to restore.

![](./docs/restore-ui.gif)

### `gotrash clear`

`gotrash clear` deletes all trashed files and directories.

![](./docs/clear.gif)

## LICENSE

[MIT](./LICENSE)