Editing Bulk rename files with Vim

{{TipNew
|id=1642
|previous=1641
|next=1643
|created=2009
|complexity=basic
|author=Whiteinge
|version=7.0
|subpage=/200912
|category1=
|category2=
}}
You can use Vim to quickly rename many files at once. The steps are: create a list of files; change the list by constructing commands to rename each file; execute the commands. This is essentially an in-memory simplistic shell script.

==Unix shell==
===Create list of files===
Starting at a shell prompt, you can send a list of file names to the standard input of Vim by entering:
<pre>
\ls | vim -
</pre>

The backslash tells your shell to disregard any aliases for <code>ls</code>; we need plain output with no color. Vim will open, displaying a list of file names.

===Change to list of shell commands===
In Vim you now have one file name per line. We need to change each line to be a valid stand-alone shell command.

For example, to rename the files to lowercase:
<pre>
:%s/.*/mv -i & \L&/g
</pre>

To append <code>.orig</code> to each file name:
<pre>
:%s/.*/mv -i & &.orig/g
</pre>

To change all <code>.JPEG</code> extensions to <code>.jpg</code>:
<pre>
:%s/.*/mv -i & &/g
:%s/.JPEG$/.jpg/g
</pre>

To remove duplicate extensions:
<pre>
:%s/.*/mv -i & &/g
:%s/.jpg.jpg$/.jpg/g
</pre>

To substitute certain text in the filename:
<pre>
:%s/.*/\="mv -i ".submatch(0)." ".substitute(submatch(0), "foo", "bar", "g")/g
</pre>

<code>\=</code> is substitute command expression. See [[VimTip755]] for more details.

Note: In case the file name contains space character, it should be surrounded with quotes.

You can use any Vim features here ([[VimTip398|macros]] are useful), as long as each line results in a valid shell command.

===Execute the commands===
<pre>
:w !sh
</pre>

The reason this works is Vim writes a file line-by-line. So if you started with a list of 100 file names, it will execute 100 <code>mv</code> commands. Sure there are utilities that may do this better, but Vim is always available and that's one less thing you have to remember.

An alternative method of executing the commands is:
<pre>
:% | !bash
</pre>

This will pipe the whole buffer to the system command <code>bash</code>, thus executing all of the move commands. This will also replace the file with the command's output, which is useful for commands besides <code>mv</code>. You can also visually select a small subset of lines, and only execute those commands:
<pre>
:'<,'>!bash
</pre>

Again, this will replace the selected lines with the command's output which can be useful for some commands.

==See also==
*{{script|id=1721|text=renamer.vim}} plugin to list and rename files
*[https://www.reddit.com/r/vim/comments/24ju8p/vidir_a_tool_to_rename_files_with_vi/ vidir, emv, qmv] external tools which works with vim

==Comments==
{{todo}}
*Probably should generalize by adding a section for Windows.
*<s>This will work for Windows: <code>> dir /b | vim -</code> then type <code>%s/.*/move \"&\" \"&.OLD\"/</code> if you want to append <code>OLD</code> to the end of the file for example.</s>