renamer

Upgraders, please read the release notes. Please share feedback and improvement ideas here.

renamer

Renamer is a command-line utility to help rename files and folders. It is flexible and extensible via plugins.

Disclaimer

Always run this tool with the --dry-run option until you are confident the results look correct.

Synopsis

The examples below use double quotes to suit Windows users. MacOS & Linux users should use single quotes.

As input, renamer takes a list of filenames or glob patterns plus some options describing how you would like the files to be renamed.

$ renamer [options] [file...]

This trivial example will replace the text jpeg with jpg in all file and directory names in the current directory.

$ renamer --find jpeg --replace jpg *

As above but operates on all files and folders recursively.

$ renamer --find jpeg --replace jpg "**"

Custom file list

If no filenames or patterns are specified, renamer will look for a newline-separated list of filenames on standard input. This approach is useful for crafting a specific input list using tools like find. This example operates on files modified less than 20 minutes ago.

$ find . -mtime -20m | renamer --find jpeg --replace jpg

Same again but with a hand-rolled input of filenames and glob patterns. Create an input text file, e.g. files.txt:

house.jpeg
garden.jpeg
img/*

Then pipe it into renamer.

$ cat files.txt | renamer --find jpeg --replace jpg

Replace regular expression patterns

Simple example using a regular expression literal. The case-insensitive pattern /one/i matches the input file ONE.jpg, renaming it to two.jpg.

$ renamer --find "/one/i" --replace "two" ONE.jpg

Rename using JavaScript

For more complex renames. Define a plugin.

class AddMonth {
  replace (filePath) {
    const month = new Intl.DateTimeFormat('en-gb', { month: 'long' }).format(new Date())
    return filePath.replace(/^/, `[${month}] `)
  }
}

export default AddMonth

Invoke a custom replace chain using the plugin.

$ renamer --chain add-month.mjs * -d

Dry run

✔︎ pic1.jpg → [April] pic1.jpg
✔︎ pic2.jpg → [April] pic2.jpg

Rename complete: 2 of 6 files renamed.

Views

Further reading

Please see the wiki for

• Usage examples.
• More information about using plugins and writing plugins.
• The full list of command-line options.

For more information on Regular Expressions, see this useful guide.

Install

$ npm install -g renamer

---

© 2012-21 Lloyd Brookes <[e-mail]>.

Tested by test-runner. Documented by jsdoc-to-markdown.