[ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\nPlease run the buggy command with `--debug` option and write down the results.\n```\n$ gtrash find --debug\n```\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots**\nIf applicable, add screenshots to help explain your problem.\n\n**Version (please complete the following information):**\n - OS: [e.g. Linux, Mac]\n - Version [e.g. 0.0.1]\n\nThe version can be checked with `gtrash --version`\n```\n$ gtrash --version\n```\n\n**Additional context**\nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/workflows/golangci-lint.yml", "content": "# ref: https://github.com/golangci/golangci-lint-action#how-to-use\nname: golangci-lint\non:\n pull_request:\n workflow_dispatch:\npermissions:\n contents: read\njobs:\n golangci:\n name: lint\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-go@v4\n with:\n go-version: '1.22'\n cache: false\n - name: golangci-lint\n uses: golangci/golangci-lint-action@v3\n with:\n version: v1.54\n" }, { "path": ".github/workflows/release.yml", "content": "name: release\non:\n push:\n tags:\n - \"v*\"\npermissions:\n contents: write\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Set up Go\n uses: actions/setup-go@v4\n with:\n go-version: '1.22'\n\n - name: Test\n run: make test-all\n\n - name: Run GoReleaser\n uses: goreleaser/goreleaser-action@v5\n with:\n distribution: goreleaser\n version: latest\n args: release --clean\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n # needed by homebrew\n TAP_GITHUB_TOKEN: ${{ secrets.TAP_GITHUB_TOKEN }}\n # AUR\n AUR_KEY: ${{ secrets.AUR_KEY }}\n" }, { "path": ".github/workflows/test.yml", "content": "name: test\non:\n pull_request:\n branches: [ \"main\" ]\n workflow_dispatch:\njobs:\n test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n\n - name: Set up Go\n uses: actions/setup-go@v4\n with:\n go-version: '1.22'\n\n - name: Test\n run: make test-all\n" }, { "path": ".gitignore", "content": "gtrash\ndist/\n__debug_bin*\ncoverage\ncoverage.html\ncoverage.txt\n" }, { "path": ".goreleaser.yaml", "content": "version: 1\n\nbefore:\n hooks:\n - go mod tidy\n\nbuilds:\n - env:\n - CGO_ENABLED=0\n goos:\n - linux\n - darwin\n ldflags:\n - -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}} -X main.builtBy=goreleaser\n flags:\n - -trimpath\n\narchives:\n - format: tar.gz\n # this name template makes the OS and Arch compatible with the results of `uname`.\n name_template: >-\n {{ .ProjectName }}_\n {{- title .Os }}_\n {{- if eq .Arch \"amd64\" }}x86_64\n {{- else if eq .Arch \"386\" }}i386\n {{- else }}{{ .Arch }}{{ end }}\n {{- if .Arm }}v{{ .Arm }}{{ end }}\n # Only include binary in archive\n files:\n - none*\n\nchangelog:\n sort: asc\n filters:\n exclude:\n - \"^docs:\"\n - \"^test:\"\n\nbrews:\n - repository:\n owner: umlx5h\n name: homebrew-tap\n token: \"{{ .Env.TAP_GITHUB_TOKEN }}\"\n homepage: \"https://github.com/umlx5h/gtrash\"\n description: \"A Trash CLI manager written in Go\"\n license: \"MIT\"\n\naurs:\n -\n name: gtrash-bin\n homepage: \"https://github.com/umlx5h/gtrash\"\n description: \"A Trash CLI manager written in Go\"\n license: \"MIT\"\n private_key: '{{ .Env.AUR_KEY }}'\n git_url: 'ssh://aur@aur.archlinux.org/gtrash-bin.git'\n package: |-\n # bin\n install -Dm755 \"./gtrash\" \"${pkgdir}/usr/bin/gtrash\"\n\n # completions\n mkdir -p \"${pkgdir}/usr/share/bash-completion/completions/\"\n mkdir -p \"${pkgdir}/usr/share/zsh/site-functions/\"\n mkdir -p \"${pkgdir}/usr/share/fish/vendor_completions.d/\"\n\n ./gtrash completion bash | install -Dm644 /dev/stdin \"${pkgdir}/usr/share/bash-completion/completions/gtrash\"\n ./gtrash completion zsh | install -Dm644 /dev/stdin \"${pkgdir}/usr/share/zsh/site-functions/_gtrash\"\n ./gtrash completion fish | install -Dm644 /dev/stdin \"${pkgdir}/usr/share/fish/vendor_completions.d/gtrash.fish\"\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2024 umlx5h\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "Makefile", "content": ".PHONY: clean test itest lint\n\nbuild:\n\tgo build\n\nclean:\n\trm -f gtrash\n\trm -rf coverage itest/coverage\n\trm -f coverage.txt coverage.html\n\ntest-all: clean test itest report-coverage\n\nlint:\n\tgolangci-lint run\n\ntest:\n\tmkdir -p coverage\n\tgo test -cover -v ./internal/... -args -test.gocoverdir=\"$$PWD/coverage\"\n\nitest:\n\tmkdir -p itest/coverage\n\tgo build -cover\n\tdocker compose run itest\n\nreport-coverage:\n\tgo tool covdata percent -i=./coverage,./itest/coverage\n\tgo tool covdata textfmt -i=./coverage,./itest/coverage -o coverage.txt\n\tgo tool cover -html=coverage.txt -o coverage.html\n" }, { "path": "README.md", "content": "# gtrash\n\n![demo](doc/image/demo.gif)\n\n`gtrash` is a trash CLI manager that fully complies with the [FreeDesktop.org specification](https://specifications.freedesktop.org/trash-spec/latest/). \nUnlike `rm`, `gtrash` moves files to the system trash can, enabling easy restoration of important files at any time.\n\nIf you usually use `rm` in the shell, `gtrash` can serve as a substitute.\n\nThis tool utilizes the system trash can on Linux, enabling seamless integration with other CLI and desktop applications.\n\nAdditionally, `gtrash` features a modern TUI interface, making it very intuitive to restore any file.\n\nThe interface is made with an awesome [bubbletea](https://github.com/charmbracelet/bubbletea) TUI framework.\n\n## Table of Contents\n- [Features](#features)\n- [Supported OS](#supported-os)\n- [Installation](#installation)\n- [Usage](#usage)\n- [How it works](#how-it-works)\n- [FAQ](#faq)\n- [Tips](#tips)\n- [Configuration](#configuration)\n- [Related projects](#related-projects)\n\n## Features\n\n- Intuitive TUI interface for file restoration\n - Allows incremental search for trashed files, enabling the restoration of multiple files simultaneously.\n- Full compliance with FreeDesktop.org specification\n - Supports directory size caching, enabling fast size-based filtering and pruning.\n- Close compatibility with rm interface\n - Has rm-like mode, You can customize -r, -d behavior\n- Multi subcommands design in a single static binary written in Go\n- Restoration of co-deleted files together\n- Easy integration with other CLI tools, such as fzf\n- Safe and Ergonomic\n - Ensures safety by displaying a list and confirmation prompt whenever a file is permanently deleted.\n\n\n## Supported OS\n\n### Linux\nSupported\n\n### Mac\nSupported\n\nbut Mac's system trash can is not used\n\n### Windows\nNot supported\n\nIt works perfectly on WSL2 because it is real Linux\n\n## Installation\n\n### From binaries\n\nDownload the binary from [GitHub Releases](https://github.com/umlx5h/gtrash/releases/latest) and place it in your `$PATH`.\n\nInstall the latest binary to `/usr/local/bin`:\n\n```bash\ncurl -L \"https://github.com/umlx5h/gtrash/releases/latest/download/gtrash_$(uname -s)_$(uname -m).tar.gz\" | tar xz\nchmod a+x ./gtrash\nsudo mv ./gtrash /usr/local/bin/gtrash\n```\n\n### AUR (Arch User Repository)\n\nwith any AUR helpers\n```\nyay -S gtrash-bin\nparu -S gtrash-bin\n```\n\n### Nixpkgs (NixOS)\n\n```\nnix-env -iA nixpkgs.gtrash\n```\n\n### Homebrew (macOS)\n\n```\nbrew install umlx5h/tap/gtrash\n```\n\n### Go install\n\n```\ngo install github.com/umlx5h/gtrash@latest\n```\n\n### Build from source\n\n```bash\ngit clone https://github.com/umlx5h/gtrash.git --depth 1\ncd gtrash\ngo build\n./gtrash\nsudo cp ./gtrash /usr/local/bin/gtrash\n```\n\n## Usage\n\nTo trash a file, use the `put` subcommand. \nDeleting a directory doesn't require the `-r` option by default. \n(This behavior can be adjusted using --rm-mode.)\n\n```bash\n$ cd && mkdir dir && touch file1 file2\n$ gtrash put dir file1 file2\n```\n\nThe `summary` subcommand provides information about the trash can, displaying item count and total size. \nThere is a path name, the file has been moved to this path.\n\n```\n$ gtrash summary\n[/home/user/.local/share/Trash]\nitem: 3\nsize: 4.1 kB\n```\n\nThe `find` subcommand lists the files in the trash. \nThe `Path` field shows the original file location, not the one in the trash.\n\n```bash\n# gtrash f is also acceptable\n$ gtrash find\nDate Path\n2024-01-01 00:00:00 /home/user/dir\n2024-01-01 00:00:00 /home/user/file1\n2024-01-01 00:00:00 /home/user/file2\n```\n\nString queries can be passed as command line arguments for searching files in the trash, using regular expressions by default.\n\n```bash\n$ gtrash find file1 dir\nDate Path\n2024-01-01 00:00:00 /home/user/dir\n2024-01-01 00:00:00 /home/user/file1\n```\n\nThere are several ways to restore a file. \nTo restore with an interactive TUI, use the `restore` subcommand.\n\n```bash\n# gtrash r is also acceptable\n$ gtrash restore\n```\n\n![restore-table](./doc/image/restore_table.jpg)\n\nWithin `restore`, multiple files can be selected for restoration. \n\nThe table on the left is the list of files in the trash and the table on the right is the list to be restored.\n\nPress `?` for detailed operations. \nNavigate using `j`, `k`, or the cursor keys. \nUse `l` or `right arrow key` or `Space` to move files to the right table. \n\nVim key bindings are used. \nIncremental searches can be performed with `/`. \nPress `Enter` after selecting files to restore.\nA list of selected files and a confirmation prompt will appear. Confirm restoration by pressing `y`.\n\n```bash\n$ gtrash restore\nDate Path\n2024-01-01 00:00:00 /home/user/dir\n2024-01-01 00:00:00 /home/user/file1\n\nSelected 2 trashed files\nAre you sure you want to restore? yes/no\n```\n\nThere is another type of restoration with TUI. \nTo restore all the deleted files together in one `put` command, use the `restore-group` subcommand.\n\n```bash\n# gtrash rg is also acceptable\n$ gtrash restore-group\n```\n\nIn above example, `dir1`, `file1`, and `file2` can be restored together. \nThis is useful when many files were deleted together but you want to restore them at once.\n\nFor non-TUI restoration, use the `--restore` option with `find`.\n\n```bash\n$ gtrash find file1 dir --restore\nDate Path\n2024-01-01 00:00:00 /home/user/dir\n2024-01-01 00:00:00 /home/user/file1\n\nFound 2 trashed files\nAre you sure you want to restore? yes/no\n```\n\nTo permanently delete files in the trash, use the `--rm` option with `find`. \nBe aware that this action is irreversible, akin to rm, and the files cannot be restored.\n\n```\n# Delete specific files\n$ gtrash find file1 --rm\n\n# Delete all files\n$ gtrash find --rm\n```\n\nHelp can be viewed with the `-h` option.\nExamples are provided for each subcommand.\n\n```\n$ gtrash -h\n$ gtrash put -h\n```\n\n\n## How it works\n\n`gtrash` adheres to the [FreeDesktop.org specification](https://specifications.freedesktop.org/trash-spec/latest/).\n\nIts primary function is akin to `mv`, but it extends functionality by recording meta-information and automatically transferring files to the trash can in the external file system.\n\nFiles within the main file system are moved to the following paths in the home directory.\n\n```bash\n# Standard\n$HOME/.local/share/Trash\n\n# If $XDG_DATA_HOME is set\n$XDG_DATA_HOME/Trash\n```\n\nThe files are moved to the `files` directory, while metadata is stored in the `info` directory.\n\n```bash\n$ gtrash put file1\n\n# Records meta information\n$ cat ~/.local/share/Trash/info/file1.trashinfo\n[Trash Info]\nPath=/home/user/file1\nDeletionDate=2024-01-01T00:00:00\n\n# Actual file\n$ ls ~/.local/share/Trash/files/file1\n/home/user/.local/share/Trash/files/file1\n```\n\nFiles within an external file system will be moved to either of the subsequent paths.\n\n```bash\n# If a .Trash folder already exists, it will be used.\n# ($uid folder is created automatically)\n# The .Trash directory requires a sticky bit set (can be added using chmod +t)\n$MOUNTPOINT/.Trash/$uid\n\n# Used when the above directory is unavailable (typically used)\n$MOUNTPOINT/.Trash-$uid\n```\n\nTo use the first directory, create a `.Trash` directory in advance:\n\n```bash\n# You can check with the df command\n$ cd $MOUNTPOINT\n\n$ mkdir .Trash\n$ chmod a+rw .Trash\n\n# Set the sticky bit\n$ chmod +t .Trash\n```\n\n`$MOUNTPOINT` is the same as the information displayed in the `df` command.\n\n```\n# Mounted on\n$ df foo\nFilesystem Size Used Avail Use% Mounted on\n/dev/sda 54G 48G 3.6G 93% /\n```\n\nThe `mv` command copies and deletes files when moving across file systems. \nThis process consumes more time and increases disk usage on the destination file system. \n\nThe inability to use the [rename(2)](https://man7.org/linux/man-pages/man2/rename.2.html) syscall across different file systems necessitates this behavior.\n\nFor this reason, `gtrash` attempts to move files to the trash can within the same file system whenever possible. \nYou can also configure it to always use the trash can in the `$HOME` directory.\n\nRefer to the [Configuration](doc/configuration.md) for further details.\n\nThe `summary` subcommand lists paths to all trash cans:\n\n```bash\n$ gtrash summary\n```\n\nUsing the `--show-trashpath` option with the `find` command displays the real path for each trashed file.\n\n```bash\n$ gtrash find --show-trashpath\n```\n\nFor detailed behavior insights, run the command with the `--debug` option to view internal processes.\n\n\n## FAQ\n### What's the difference between this command and the rm command?\n\nWhile `rm` uses the [unlink](https://man7.org/linux/man-pages/man2/unlink.2.html) syscall, rendering file deletion irreversible, `gtrash` moves files using the [rename](https://man7.org/linux/man-pages/man2/rename.2.html) syscall, enabling restoration.\n\n`gtrash` aims to mirror the `rm` interface but ignores `-r`, `-R`, `--recursive`, and `-d` by default.\n\n```bash\n$ gtrash put -h\nFlags:\n -d, --dir ignored unless --rm-mode set\n -f, --force ignore nonexistent files and arguments\n -i, --interactive prompt before every removal\n -I, --interactive-once prompt once before trashing\n -r, -R, --recursive ignored unless --rm-mode set\n --rm-mode enable rm-like mode (change behavior -r, -R, -d)\n -v, --verbose explain what is being done\n```\n\nThe `-r` option is not necessary for deleting folders since files are restorable even if mistakenly removed.\n\nHowever, some users may prefer the `rm` behavior. In such cases, enable the above option with `--rm-mode`.\n(Although it is not completely compatible.)\n\n```bash\n# To delete a folder, -r or -d is required.\n$ gtrash put --rm-mode dir1/\ngtrash: cannot trash \"dir1/\": Is a directory\n\n$ gtrash put --rm-mode -r dir1/\n```\n\nThis behavior can be set using an environment variable or an alias, whichever suits your preference.\n\n```\n# Same as --rm-mode\n$ GTRASH_PUT_RM_MODE=\"true\" gtrash put -r dir/\n\n# Alias is also possible\n$ alias gtrash-put=\"gtrash put --rm-mode\"\n```\n\n### What are the advantages of using a system trash can?\n\n`gtrash` offers several benefits over similar applications like [rip](https://github.com/nivekuil/rip) that don't utilize the Linux system trash can.\n\n* Seamless integration with CLI and desktop applications following the FreeDesktop specification.\n* Support for various trash cans, even on different file systems, enabling fast file movement between them.\n* Compatibility with standard specifications ensures smoother migration to alternative applications adhering to the same standards.\n * Unique specifications become a problem when they are no longer maintained.\n\n### Can I alias `rm=gtrash put`?\n\nYou can but I do not recommend due to potential risks, unintentionally executing actual `rm` commands, such as `sudo rm` or on SSH servers.\n\nAs `gtrash` isn't fully compatible with `rm`, it's prudent to establish different aliases to avoid confusion and prevent accidental deletion of files.\n\nConsider setting up alternative short aliases, such as:\n\n```bash\nalias gp='gtrash put' # gtrash put\nalias gm='gtrash put' # gtrash move (easy to change to rm)\nalias tp='gtrash put' # trash put\nalias tm='gtrash put' # trash move (easy to change to rm)\nalias tt='gtrash put' # to trash\n```\n\nIf you are in the habit of using rm, consider creating an alias that displays a cautionary message.\n\n```bash\nalias rm=\"echo -e 'If you want to use rm really, then use \\\"\\\\\\\\rm\\\" instead.'; false\"\n```\n\nWhen you want to execute the actual rm, use `\\rm` to bypass the alias.\n\n```bash\n$ rm foo\nIf you want to use rm really, then use \"\\rm\" instead.\n\n$ \\rm foo\n```\n\n### Can I run `trash put` in one command without using alias?\n\nIn certain situations, supporting trash cans within programs might necessitate working with a trash CLI without the ability to specify a subcommand like `gtrash put`.\n\nIn such cases, consider a simple wrapper script.\n\n```bash\n# Locate gtrash binary path\n$ which gtrash\n/usr/local/bin/gtrash\n\n$ sudo vim /usr/local/bin/gtrash-put\n#!/bin/sh\n\n# Specify gtrash binary path\nexec /usr/local/bin/gtrash put \"$@\"\n\n$ sudo chmod a+x /usr/local/bin/gtrash-put\n```\n\nWith this setup, execute a single command.\n\n```bash\n$ gtrash-put somefile\n```\n\nThis wrapper facilitates direct execution without needing an alias.\n\n### Is gtrash compatible with the gio trash and trash-put commands?\n\nIt uses the exact same trash FreeDesktop specification as `gio trash` and `trash-cli`, so they are compatible. \nIf some program depends on these clis and cannot be changed, there is no need to change to `gtrash put`.\n\n### Typing `gtrash` takes too long\n\nSet up an different alias from put.\n\nExample\n```bash\nalias gp=\"gtrash put\"\nalias g=\"gtrash\"\n```\n\nOr you could setup a symbolic link.\n\n```bash\nsudo ln -s /usr/local/bin/gtrash /usr/local/bin/g\n```\n\nNote that gtrash works perfectly well with any binary name.\n\nIf you don't like the name \"gtrash\", you can change it to whatever name you like.\n\n```\nsudo mv /usr/local/bin/gtrash /usr/local/bin/rip\n```\n\nHowever, be aware that if you are installing via a package manager, you may not be able to update it.\n\n### What happens when I run it with sudo?\n\nFiles are moved to the Trash under the `root` user's home directory.\n\n```\n$ sudo bash -c 'echo $HOME'\n/root\n```\n\nThe `-v` option displays the location where the file was moved.\n\n```\n$ sudo gtrash put -v file1\ntrashed \"file1\" to /root/.local/share/Trash\n```\n\nThe `summary` subcommand can also reveal the Trash can location.\n```\n$ sudo gtrash summary\n[/root/.local/share/Trash]\nitem: 10\nsize: 62 kB\n```\n\nTo restore or delete a file deleted with sudo, you need to use sudo.\n\n### How does the `restore-group` subcommand work?\n\nThe `restore-group` subcommand can restore multiple deleted files simultaneously with one command.\n\n```bash\n$ gtrash put file1 file2 dir\n\n# You can restore file1, file2, dir together\n$ gtrash restore-group\n```\n\nHowever, it's not an exact grouping of files deleted at the same time. \nFiles with the same deletion timestamp recorded in seconds are simply grouped together.\n\nWhen files are trashed using `gtrash put`, they are designed to have the same timestamp, allowing reliable grouping. \nBut this isn't guaranteed if trashed via other apps.\n\nNote that multiple `gtrash put` commands executed within one second are also grouped together.\n\nIn an interactive shell executing `gtrash put`, timestamps rarely match within seconds. However, caution is needed when running it via a shell script.\n\nIn such cases, use the `restore` subcommand to select specific files.\n\n### What does the `metafix` subcommand do?\n\n`trash put` command records meta-information in the `info` folder in the Trash directory and moves files to the `files` directory.\n\n```bash\n$ gtrash put file1\n\n# Records meta information\n$ cat ~/.local/share/Trash/info/file1.trashinfo\n[Trash Info]\nPath=/home/user/file1\nDeletionDate=2024-01-01T00:00:00\n\n# Actual file\n$ ls ~/.local/share/Trash/files/file1\n/home/user/.local/share/Trash/files/file1\n```\n\nFor instance, if you manually delete files from the `files` directory, the trash will become inconsistent.\n\n```bash\n# Deletes the file only, not the meta info\n$ rm ~/.local/share/Trash/files/file1\n```\n\nIn such cases, `find` and `restore` commands won't display inconsistent orphaned meta-information.\n\n`metafix` can detect this condition and remove unnecessary meta-information.\n\n```bash\n$ gtrash metafix\nDate Path\n2024-01-01 00:00:00 /home/user/file1\n\nFound invalid metadata: 1\nAre you sure you want to remove invalid metadata? yes/no\n```\n\nThe following trashinfo file will be deleted instead of the file.\n\n```bash\n$ ls ~/.local/share/Trash/info/file1.trashinfo\nls: cannot access '/home/user/.local/share/Trash/info/file1.trashinfo': No such file or directory\n```\n\n### The display in the TUI is corrupted\n\nIt seems that the table in TUI may be corrupted on certain terminals. \nThe display of the library used itself may be corrupted and may not be able to be fixed. \nIn that case, I recommend migrating the terminal.\n\nTerminal confirmed that it cannot be fixed\n* KDE Konsole\n\nTerminal confirmed to work\n* Wezterm\n* Alacritty\n* Kitty\n* GNOME Terminal\n* Xfce Terminal\n* Windows Terminal\n* Mac Terminal\n* Mac iTerm2\n\nIf you find a problem, please open an ticket.\n\n## Tips\n\n### Shell Integration\n\n`gtrash` supports `bash`, `zsh`, `fish` shell integration. \nSee `--help` for further details.\n\n```bash\ngtrash completion bash --help\ngtrash completion zsh --help\ngtrash completion fish --help\n```\n\n### Filtering by the current working directory or specific directory\n\nBy default, `find` and `restore` display all files, not limited to the current directory. \nThis differs from other applications.\n\nYou can filter using the `-c` option (`--cwd`).\n\n```bash\n# --cwd is also acceptable\n$ gtrash find -c\n$ gtrash restore -c\n```\n\nThe `restore` subcommand also supports filtering by the current directory in the TUI.\n\nAvoid using `-c`, directly access the TUI, and press the `c` key to toggle filtering.\n\n```bash\n$ gtrash restore\n\n# Press the c key\n```\n\nThe `-d` or `--directory` option allows filtering in directories other than the current one.\n\n```bash\n# Specify an absolute path\n$ gtrash find -d /tmp\n\n# relative path is also supported\n$ gtrash find -d ./foo\n\n# Same as -c\n$ gtrash find -d .\n```\n\n### Fuzzy find\n\nFuzzy find isn't currently implemented due to complexity. \nHowever, `gtrash` is designed to work seamlessly with other commands like fzf.\n\nThe find subcommand outputs a tab-delimited table if it detects pipe or file output other than a terminal. \nThis enables easy field extraction using tools like awk.\n\nExample with fzf:\n\n```bash\n# Fuzzy find one item and get the original path\n# Specify -F'\\t' due to tab-delimited output\n$ gtrash find | fzf | awk -F'\\t' '{print $2}'\n\n# Fuzzy find multiple items and get the original path\n$ gtrash find | fzf --multi | awk -F'\\t' '{print $2}'\n```\n\nFor permanent removal or restoration, specify the original path as a command-line argument in the `rm` or `restore` subcommand. \nNote that the `-o` option must be specified when using `xargs` to display the confirmation prompt.\n\n```bash\n# Fuzzy find multiple items and permanently remove them\n$ gtrash find | fzf --multi | awk -F'\\t' '{print $2}' | xargs -o gtrash rm\n\n# Fuzzy find multiple items and restore them\n$ gtrash find | fzf --multi | awk -F'\\t' '{print $2}' | xargs -o gtrash restore\n```\n\n### Pruning the trash can by size and date criteria\n\nDate-based:\n\nCurrently possible only by day.\n\n```bash\n# Remove files deleted over a week ago\n$ gtrash prune --day 7\n\n# Almost the same as prune\n$ gtrash find --day-old 7 --rm\n```\n\nSize-based:\n\nThere are two methods.\n\n`find` filters by the specified size and removes them.\n\n```bash\n# Remove trashed files larger than 10MB\n$ gtrash find --size-large 10mb --rm\n\n# '10m' is also acceptable\n$ gtrash find --size-large 10m --rm\n\n# Remove trashed files larger than 1GB\n$ gtrash find --size-large 1gb --rm\n\n# Remove empty trashed files\n$ gtrash find --size-small 0 --rm\n```\n\n`prune` removes large files first so that the overall trash size is smaller than the specified size:\n```\n# After this, the size of the trash can is guaranteed to be less than 5 GB.\n$ gtrash prune --size 5GB\n\n# If you want to exclude recently deleted files, you can also specify day.\n$ gtrash prune --size 5GB --day 7\n```\n\nSizes and dates can be combined in `find`, and other filters can be applied:\n```bash\n# Remove files older than a week and larger than 10MB\n$ gtrash find --day-old 7 --size-large 10mb --rm\n\n# Remove files older than a week, larger than 10MB, and containing 'foo' in the path\n$ gtrash find --day-old 7 --size-large 10mb --rm foo\n```\n\n## Configuration\n\nCertain behaviors can be altered by setting environment variables. \nRefer to the [Configuration](doc/configuration.md).\n\n## Related projects\n\n### Using system trash can\n\n* [andreafrancia/trash-cli](https://github.com/andreafrancia/trash-cli)\n* [oberblastmeister/trashy](https://github.com/oberblastmeister/trashy)\n* [rushsteve1/trash-d](https://github.com/rushsteve1/trash-d)\n\nFor a comparison, You can see [alternatives.md](doc/alternatives.md).\n\n### Not using system trash can\n\n* [nivekuil/rip](https://github.com/nivekuil/rip)\n* [babarot/gomi](https://github.com/babarot/gomi)\n\nThis program is mainly inspired by [babarot/gomi](https://github.com/babarot/gomi).\n" }, { "path": "doc/alternatives.md", "content": "# Alternatives\n\n| | gtrash | [trash-cli](https://github.com/andreafrancia/trash-cli) | [trashy](https://github.com/oberblastmeister/trashy) | [trash-d](https://github.com/rushsteve1/trash-d) |\n| ------------------------------------------------------------ | --------------------------------- | ------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------ |\n| Language | Go | Python | Rust | D |\n| Supported OS | Linux,Mac | Linux,Mac | Linux,Windows | Linux,Mac |\n| Architecture | Single binary & Multi subcommands | Multi commands | Single binary & Multi subcommands | Single binary |\n| Has rm-like interface | ✔️ | ✔️ | ❌ | ✔️ |\n| Restore with TUI (incremental search & multi select items) | ✔️ | ❌ | ❌ | ❌ |\n| Restore as a group | ✔️ | ❌ | ❌ | ❌ |\n| Can show file and directory size | ✔️ | ❌ | ❌ | ❌ |\n| Can show summary of trash cans (total items, size) | ✔️ | ❌ | ❌ | ❌ |\n| Support FreeDesktop.org directorysize cache | ✔️ | ❌ | ❌ | ✔ (only put, can not list) |\n| Support FreeDesktop.org fallback to home trash | ✔️ | ✔️ | ❌ | Not support external filesystem trash can |\n| Size-based pruning | ✔️ | ❌ | ❌ | ❌ |\n| Date-based pruning | ✔️ | ✔️ | ✔️ | ❌ |\n| Safe (Always show a confirmation prompt before deleting files by default?) | ✔️ | ❌ | ✔️ | ❌ |\n| Sort trashed items by deletion date by default? | ✔️ | ❌ | ✔️ | ❌ |\n\n\nIf you think that some entries in this table are outdated or wrong, please open a issue or pull request.\n" }, { "path": "doc/configuration.md", "content": "# Configration\n\nCertain behaviors can be altered by setting environment variables. \n\n## GTRASH_HOME_TRASH_DIR\n\n- Type: string\n- Default: `$XDG_DATA_HOME/Trash ($HOME/.local/share/Trash)`\n\nChange the location of the main file system's trash can by specifying the full path.\n\nExample: If you prefer placing it directly under your home directory:\n\n```bash\nexport GTRASH_HOME_TRASH_DIR=\"$HOME/.gtrash\"\n```\n\n## GTRASH_ONLY_HOME_TRASH\n\n- Type: bool ('true' or 'false')\n- Default: `false`\n\nEnabling this option ensures the sole usage of the home directory's trash can.\n\nWhen files from external file systems are deleted using the `put` command, they're copied to the trash can in `$HOME`. This process might take longer due to copying and increase the main file system's disk space.\n\nBy default (false), it searches for trash cans across all mount points and displays them using `find` and `restore` commands. This includes network and USB drives, potentially causing slower operation.\n\nIf you encounter such issues, enabling this option can be helpful.\n\n```bash\nexport GTRASH_ONLY_HOME_TRASH=\"true\"\n```\n\n## GTRASH_HOME_TRASH_FALLBACK_COPY\n\n- Type: bool ('true' or 'false')\n- Default: `false`\n\nEnable this option to fallback to using the home directory's trash can when the external file system's trash can is unavailable. Enabling this option might resolve errors encountered while deleting files on an external file system using the `put` command.\n\nIt can also be set using the `--home-fallback` option.\n\n```bash\n$ gtrash put --home-fallback /external/file1\n\n# Equivalent to the above\n$ GTRASH_HOME_TRASH_FALLBACK_COPY=\"true\" gtrash put /external/file1\n\n# To disable it when enabled in the environment variable\n$ GTRASH_HOME_TRASH_FALLBACK_COPY=\"true\" gtrash put --home-fallback=false /external/file1\n```\n\n```bash\nexport GTRASH_HOME_TRASH_FALLBACK_COPY=\"true\"\n```\n\n## GTRASH_PUT_RM_MODE\n\n- Type: bool ('true' or 'false')\n- Default: `false`\n\nEnabling this option changes the behavior of the `put` command as closely as possible to `rm`.\n\nThe `-r`, `--recursive`, `-R`, `-d` options closely resemble `rm` behavior. When set to false, these options are completely ignored.\n\nThis setting can also be configured using the `--rm-mode` option.\n\n```bash\n$ gtrash put --rm-mode -r dir1/\n\n# Equivalent to the above\n$ GTRASH_PUT_RM_MODE=\"true\" gtrash put -r dir/\n```\n\n```bash\nexport GTRASH_PUT_RM_MODE=\"true\"\n```\n" }, { "path": "doc/image/demo.tape", "content": "# VHS documentation\n#\n# Output:\n# Output .gif Create a GIF output at the given \n# Output .mp4 Create an MP4 output at the given \n# Output .webm Create a WebM output at the given \n#\n# Require:\n# Require Ensure a program is on the $PATH to proceed\n#\n# Settings:\n# Set FontSize Set the font size of the terminal\n# Set FontFamily Set the font family of the terminal\n# Set Height Set the height of the terminal\n# Set Width Set the width of the terminal\n# Set LetterSpacing Set the font letter spacing (tracking)\n# Set LineHeight Set the font line height\n# Set LoopOffset % Set the starting frame offset for the GIF loop\n# Set Theme Set the theme of the terminal\n# Set Padding Set the padding of the terminal\n# Set Framerate Set the framerate of the recording\n# Set PlaybackSpeed Set the playback speed of the recording\n# Set MarginFill Set the file or color the margin will be filled with.\n# Set Margin Set the size of the margin. Has no effect if MarginFill isn't set.\n# Set BorderRadius Set terminal border radius, in pixels.\n# Set WindowBar Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)\n# Set WindowBarSize Set window bar size, in pixels. Default is 40.\n# Set TypingSpeed