A simple tool for clever mass-renaming files.
Simply run the following commands:
go get github.com/SlyMarbo/go-renamecd $GOPATH/src/github.com/SlyMarbo/go-renamego install
Alternatively, use a pre-built binary:
Renaming operations can be given a dry-run with the -t or --test flags, which print which operations
would have been performed without actually changing the filesystem.
Similarly, the -l or --list flag can be used to list which files would have been renamed without making
any changes.
Simple renaming is performed with the --from and --to flags, which use plain strings. For example,
$ go-rename --from "foo" --to "bar"
will replace the first instance of foo with bar for each filename in the current directory.
To limit renaming to files with a particular extension, use the --ext flag. For example,
$ go-rename --from "foo" --to "bar" --ext ".txt"
will only perform the rename operation on files with the extension .txt.
To recurse into child directories, use the -R flag. For example,
$ go-rename -R --from "foo" --to "bar"
will replace the first instance of foo with bar for each filename in the current directory and any child
directories.
To enable multiple replacements within each filename, use the -n flag. For example,
$ go-rename -n 3 --from "foo" --to "bar"
will replace up to 3 instances of foo with bar for each filename in the current directory.
To allow any number of replacements per file, use -n -1.
To use a regular expression in your matching string, use the --from-regex flag instead of --from. For
example,
$ go-rename --from-regex "%d+" --to "num"
will replace the first instance of one or more numbers with num for each filename in the current directory.
The syntax of the regular expressions accepted is the same general syntax used by Perl, Python, and other
languages. More precisely, it is the syntax accepted by RE2 and described at
http://code.google.com/p/re2/wiki/Syntax, except for \C. Furthermore, the backslash character (\) has been
replaced with the percent character (%) to avoid the need to escape backslashes in the shell. If in doubt
about how the regex will work, simply use -t to experiment.
To use a regular expression in your replacement string, use the --to-regex flag instead of --to. For
example,
$ go-rename --from-regex "(%d+)" --to-regex "%1_old"
will append _old to the first instance of one or more numbers for each filename in the current directory.
Each group in the matching regex (groups are made with brackets) is assigned a number, starting at 1. The
content of a group can be inserted into the replacement regex by using %# where # is a group number.
Other than groupings, --to-regex is treated as a normal string. A literal percent character can be used
as %%, as with --from-regex.
Note that this only works when combined with --from-regex. If used with --from, it is treated as --to.
To performa a numerical operation on a number at the beginning or end of a filename (ignoring the extension),
use the --number-start or --number-end flag, as appropriate. For example,
$ go-rename --number-start +2
will modify each file in the current directory such that any number at the beginning of the filename is
incremented by two. --number-start and --number-end currently support addition and subtraction and both
will perform the renamings in such an order that it is safe (so --number-start +1 would rename 2.jpg
before 1.jpg).
To ensure a certain number width with zero padding, use the -z or --zero-pad flag. For example,
$ go-rename --number-start +2 -z 2
will perform the numerical modification, and pad the result with zeros as necessary. In this case, 1.jpg
would be renamed to 02.jpg.
Use the -v or --verbose flags to enable the printing of any warnings or other non-error information.