# Renam
Blazingly fast file renaming utility with regex.

## Why
1. [just for fun](https://justforfunnoreally.dev/) [![justforfunnoreally.dev badge](https://img.shields.io/badge/justforfunnoreally-dev-9ff)](https://justforfunnoreally.dev)
2. It's faster than linux 'rename' utility
3. It supports large amounts of files, unlike 'rename'

## Installation
`cargo install renam`

## Usage
`renam "regex pattern" "replacement" [optional folder]`

Example:
Folder contains files named:
- 1-x.img
- 2-x.img
- 3-x.img

To turn x into z:
`renam "x" "z"`

By default renam renames files in current directory. Directory can be specified at the end: `renam "x" "z" "path/to/folder"`

If you want to see which files were changed, you can use `-v` flag, and if you want to also see all files that were not renamed, use `-vv`

If you only want to see what changes will happen, but not actually commit them, use `-d` (with `-v`/`-vv` flag)

You can also rename files recursively using `-r` flag, and specify max depth of it using `--max-depth`.

## Changelog

### 0.3.0
#### Added
- Recursive renaming with flag
- Max depth of recursive renaming

### 0.2.0
#### Added
- Added verbose flag, which allows printing out which files are changed (or were left unchanged if used `-vv`)
- Added dry run flag, which causes program to not actually rename files, useful with verbose flag

## Aknowledgements 
Dedications to [renamer](https://crates.io/crates/renamer) (I wanted to call my project that but this was first lol) which seems better (has incrementing which I do not plan to include) but from my benchmarks slightly slower, and to rename which is also slower :3

And to other similar projects.