An open API service indexing awesome lists of open source software.

https://github.com/gabrielcapilla/zrm

Remove folders and files easily and efficiently
https://github.com/gabrielcapilla/zrm

cli nim tool

Last synced: 9 months ago
JSON representation

Remove folders and files easily and efficiently

Awesome Lists containing this project

README

          

# zrm

`zrm` is a command-line tool written in Nim that enhances file and folder deletion by integrating with `fzf` (a command-line fuzzy finder). It provides a fast and interactive way to select multiple items for deletion.

## Features

- **Interactive Deletion:** Uses `fzf` to create a fuzzy-searchable, interactive list of files and directories.
- **Multiple Selections:** Select one or more items to delete using the `` key.
- **Safety First:**
- Requires confirmation before deleting any files.
- Prevents the deletion of critical system paths like your home directory (`/home/user`) or the root directory (`/`).
- **Efficient:** Quickly lists items in the current directory for selection.

## Prerequisites

- [Nim](https://nim-lang.org/install.html) (version 2.2.4 or higher)
- [fzf](https://github.com/junegunn/fzf#installation)

## Installation

### Install using Nimble
```bash
nimble install https://github.com/gabrielcapilla/zrm.git
```

### Build

1. **Clone the repository:**
```bash
git clone https://github.com/gabrielcapilla/zrm.git
cd zrm
```

2. **Install dependencies and build the project using Nimble:**
```bash
nimble install
```

## Usage

Simply run `zrm` in any directory:

```bash
zrm
```

This will open an `fzf` window listing all files and subdirectories in the current location.

- Navigate the list with the arrow keys.
- Use `` to select one or more items.
- Press `` to confirm your selection.
- Type `y` to confirm the deletion or `n` to cancel.

## Uninstallation

To remove `zrm` from your system, use Nimble:

```bash
nimble uninstall zrm
```

---

**Documentation automatically generated by the artificial intelligence model [Gemini CLI](https://github.com/google-gemini/gemini-cli).*