https://github.com/bios-marcel/wastebasket

A crossplatform go library for moving files to the trashbin
https://github.com/bios-marcel/wastebasket

delete go golang linux macos recyclebin remove trash trashbin windows

Last synced: 2 days ago
JSON representation

A crossplatform go library for moving files to the trashbin

• Host: GitHub
• URL: https://github.com/bios-marcel/wastebasket
• Owner: Bios-Marcel
• License: mpl-2.0
• Created: 2018-08-29T17:33:18.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-17T19:38:27.000Z (8 months ago)
• Last Synced: 2024-06-21T16:50:43.658Z (5 months ago)
• Topics: delete, go, golang, linux, macos, recyclebin, remove, trash, trashbin, windows
• Language: Go
• Homepage:
• Size: 394 KB
• Stars: 32
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wastebasket

[![CI](https://github.com/Bios-Marcel/wastebasket/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/Bios-Marcel/wastebasket/actions/workflows/test.yml) [![codecoverage](https://codecov.io/gh/Bios-Marcel/wastebasket/branch/master/graph/badge.svg?token=yy8qX4BQbT)](https://codecov.io/gh/Bios-Marcel/wastebasket)

Wastebasket is a go library / CLI tool allowing you to interact with your system trashbin.

## Dependencies

### Golang

The library supports at least the 3 latest major Golang versions. Depending on

your OS it might still work on an older version, but there are no guarantees.

### Windows

There are no dependencies, it depends on the Shell32 API built into Windows.

**No CGO required**

### Linux (Unix)

There are two (well, four) options you've got here. Wastebasket offers a native

golang implementation of the [FreeDesktop Trash specification](https://specifications.freedesktop.org/trash-spec/trashspec-latest.html).

Additionally, the custom implementation should also work for systems such

as BSD and its derivatives. However, this has not been tested and I do not

plan on doing so, simply because GitHub does not currently support running

tests on any BSD derivatives.

If anyone is willing to host a custom runner (which I think is possible), then

I'd be open to this though.

**No CGO required**

### Mac OS

The only dependency is `Finder`, which is installed by default.

There are plans for a better implementation, that uses the Objective-C API

provided by Mac OS, resulting in most likely much better performance.

**No CGO required (Might change in the future)**

## Library usage

Grab it via

```bash

go get github.com/Bios-Marcel/wastebasket

```

and you are ready to go.

Minimal Go example that creates a file, deletes it and empties the trashbin:

```go

package main

import (

    "fmt"

    "os"

    "github.com/Bios-Marcel/wastebasket"

)

func main() {

    os.WriteFile("test.txt", []byte("Test"), os.ModePerm)

    fmt.Println(wastebasket.Trash("test.txt"))

    wastebasket.Empty()

}

```

## CLI usage

Wastebasket can also be used as a commandline interface. You can build

executables for each subcommand (such as `empty`) separately, or build

`wastebasket` as a whole.

In order to do so, run

```shell

go build ./cmd/CMD

```

where `CMD` is whichever command you want to build.

### Autocompletion

The CLI offers autocompletion for flags and pre-defined arguments.

Bash; Write the following into your bash profile:

```bash

source <(wastebasket completion bash)

```

Additionally, completion is supported for zsh, powershell and fish.

For information, see [Cobra shell completions](https://github.com/spf13/cobra/blob/main/shell_completions.md)

## Benchmarks

Run benchmarks using:

```go

go test -bench=.

```