A simple, powerful rename tool supports complex filtering, written in GO.

fsrename separates the pattern/replace options, therefore you can specify the pattern without typing these escaping characters and the slashes.

pre-filtering, extension filtering, prefix trimming, suffix trimming , camelcase conversion, underscore conversion are all supported.

This tool is different from gorename, gorename is for refactoring your code, rename variables.

fsrename -file -match "[a-z]+" -rr "foo_+" -with bar test
fsrename -ext cpp -replace-ext cc src

go get -u -x github.com/c9s/fsrename/fsrename

fsrename [options] [path...]

Note: When [path...] is not given, "./" will be used as the default path for scanning files.

To see the documentation in console:

go doc github.com/c9s/fsrename/fsrename

You can create a link to the package under your GOPATH to create an doc alias

ln -s $(go list -f "{{.Dir}}" github.com/c9s/fsrename/fsrename) \
    $(go list -f "{{.Root}}" github.com/c9s/fsrename/fsrename)/src/fsrename

# see the document
go doc fsrename

-match [regexp pattern] pre-filter the files and directories based on the given regular pattern.

-contains [string] pre-filter the files and directories based on the given string needle.

-f,-file only for files.

-d, -dir only for directories.

-ext [extension name] find files with matched file extension.

Please note the replacement target only works for the basename of a path. -replace* and -with* should be combined together to replace the substrings.

-r [search string], -replace [search string] specify target substring with normal string matching.

-rr [regexp pattern], -replace-re [regexp pattern], -replace-regexp [regexp pattern] specify target substring with regular expression matching.

-w [string], -with [string] replacement for the target substring.

-wf [format string], -with-format [format string] replacement with fmt.Sprintf format for the target substring.

-trim-prefix [prefix] trim filename prefix.

-trim-suffix [suffix] trim filename suffix (this option removes suffix even for filename extensions).

-camel converts dash/underscore separated filenames into camelcase filenames.

-underscore converts camelcase filesnames into underscore separated filenames.

-add-prefix [prefix] - prepend prefix to filename of the matched entries.

-add-suffix [suffix] - add suffix to filename (before the extension name) of the matched entries.

-replace-ext [ext] replace the extension fomr the matched entries. usually this option is combined with -ext [ext] to replace extension names.

-dryrun dry run, don't rename, just preview the result.

-changelog [changelog file] records the rename actions in CSV format file.

-rollback [changelog file] rollback the renames from a changelog file.

Find files with extension .php and replace the substring from the filename.

fsrename -ext "php" -replace "some" -with "others" src/

Replace Stmt.go with "_stmt.go" under the current directory:

fsrename -replace "Stmt.go" -with "_stmt.go"

Replace Stmt.go with "_stmt.go" under directory src/c6:

fsrename -replace "Stmt.go" -with "_stmt.go" src/c6

# -r is a shorthand of -replace
fsrename -r "Stmt.go" -with "_stmt.go" src/c6

Replace foo with bar from files contains prefix_

fsrename -file -contains prefix_ -replace foo -with bar test

Or use -match to pre-filter the files with regular expression

fsrename -file -match "[a-z]+" -replace foo -with bar test

Use regular expression without escaping:

fsrename -replace-regexp "_[a-z]*.go" -with ".go" src/c6

# -rre is a shorthand of -replace-regexp
fsrename -rre "_[a-z]*.go" -with ".go" src/c6

fsrename -file -replace-regexp "_[a-z]*.go" -with ".go" src/c6

fsrename -file -ext go -replace-regexp "[a-z]*" -with "123" src/c6

fsrename -dir -replace "_xxx" -with "_aaa" src/c6

fsrename -replace "_xxx" -with "_aaa" -dryrun  src/c6

Replace .cpp to .cc from the files under src/ directory:

fsrename -ext cpp -replace-ext cc src

Build your own file stream workers.

The fsrename API is pretty straight forward and simple, you can create your own filters, actors in just few lines:

import "github.com/c9s/fsrename"


input := fsrename.NewFileStream()
pipe := fsrename.NewGlobScanner()
pipe.SetInput(input)
pipe.Start()
pipe := pipe.
    Chain(fsrename.NewFileFilter()).
    Chain(fsrename.NewReverseSorter())

// start sending file entries into the input stream
input <- fsrename.MustNewFileEntry("tests")

// send EOS (end of stream)
input <- nil


// get entries from output
output := pipe.Output()
entry := <-output
....

v2.1

• Added rename log printer to support rollback.
• Supported ignoring .git/.svn/.hg directories.
• Renamed camelcase option names to dash-separated option names.

v2.2

• Added Proxy worker.
• Added rollback support: read changelog and rollback the actions

• Add -list to print the filtered file paths instead of renaming the files.
• Add -cleanup to clean up non-ascii characters
• Add --real to solve symlink reference

MIT License