Compare commits

...

4 Commits

Author SHA1 Message Date
feb0d313e8 Add badges to README 2025-11-23 07:29:54 +00:00
af6c7a0797 Fix README 2025-11-17 19:05:32 +00:00
ccaa2dcb25 Update README with new installation methods 2025-11-17 18:56:51 +00:00
Marco D'Aleo
5bb1437a49 Merge pull request #17 from mdaleo404/update_resrm_20251117
Rename workflow and make it trigger on pull requests
2025-11-17 15:10:09 +00:00

View File

@@ -1,3 +1,10 @@
![License](https://img.shields.io/github/license/mdaleo404/resrm)
[![Language](https://img.shields.io/github/languages/top/mdaleo404/resrm.svg)](https://github.com/mdaleo404/resrm/)
![GitHub Release](https://img.shields.io/github/v/release/mdaleo404/resrm?display_name=release&logo=github)
![PyPI - Version](https://img.shields.io/pypi/v/resrm?logo=pypi)
[![Build Status](https://img.shields.io/github/actions/workflow/status/mdaleo404/resrm/.github/workflows/lint-and-security.yml)](https://github.com/mdaleo404/resrm/actions)
[![PyPI downloads](https://img.shields.io/pypi/dm/resrm.svg)](https://pypi.org/project/resrm/)
# resrm
**resrm** is a safe, drop-in replacement for the Linux `rm` command with **undo/restore support**.
@@ -13,7 +20,8 @@ It moves files to a per-user _trash_ instead of permanently deleting them, while
- Supports `-r`, `-f`, `-i`, `--skip-trash` options
- Works with `sudo` for root-owned files
- Automatically prunes Trash entries older than `$RESRM_TRASH_LIFE` days (default **7**, minimum **1**)
> Note: if you need immediate deletion, use the regular `rm` command instead.
> Note: if you need immediate deletion, use the `--skip-trash` flag.
---
@@ -29,23 +37,42 @@ export RESRM_TRASH_LIFE=10
## Installation
### From package manager
This is the preferred method of installation.
**Ubuntu 22.04 and 24.04**
```
sudo add-apt-repository ppa:mdaleo/resrm
sudo apt update
sudo apt install resrm
```
**Fedora 41, 42, 43**
```
sudo dnf copr enable mdaleo/resrm
sudo dnf install resrm
```
### From PyPI
**NOTE:** To use `resrm` with `sudo`, the path to `resrm` must be in the `$PATH` seen by `root`.\
Either:
* install `resrm` as `root` (_preferred_), or
* install `resrm` as `root`, or
* add the path to `resrm` to the `secure_path` parameter in `/etc/sudoers`. For example, where `/home/user/.local/bin` is where `resrm` is:
``` bash
Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/user/.local/bin"
```
Install via PyPI (_preferred_):
Install with:
```bash
pip install resrm
```
Or clone the repo and install locally:
### From this repository
```bash
git clone https://github.com/mdaleo404/resrm.git