Utility to rename, remove, and copy files/dirs using your editor
EDIR - Rename, Delete, and Copy Files and Directories Using Your Editor
edir is a command line utility to
rename, remove, and copy filenames and directories using your text
editor. Run it in the current directory and
edir will open your editor
on a list of files and directories in that directory. Each item in the
directory will appear on its own numbered line. These numbers are how
edir keeps track of what items are changed. Delete lines to remove
files/directories, edit lines to rename files/directories, or duplicate
line numbers to copy files/directories. You can also switch pairs of
numbers to swap files or directories. If run from within a
edir will use
Git to rename or delete tracked
The latest version and documentation is available at https://github.com/bulletmark/edir.
Advantages Compared to Vidir
git mvinstead of
git rminstead of
rmfor tracked files when working in a Git repository. There is also a
-G/--no-gitoption to suppress this default action. See the description in the section below about the git options.
vidirpresents file and directories equivalently but
ediradds a trailing slash
/to visually discriminate directories. E.g. if
bdirare directories, then
vidirpresents these in your editor as follows.
1 ./a 2 ./b 3 ./c 4 ./d
edirpresents these as:
1 ./a 2 ./b 3 ./c/ 4 ./d/
Note the trailing slash is only for presentation in your editor. You are not required to ensure it is present after editing. E.g. editing line 3 above to
./e(or even just to
e) would still rename the directory
Note also, that both
vidirshow the leading
./on each entry so that any leading spaces are clearly seen, and can be edited.
ediradds the ability to copy files or directories one or more times when you duplicate a numbered line.
vidirdoes not have copy functionality.
edirallows you to remove a file/directory by deleting the line, as
vidirdoes, but you can also remove it by pre-pending a
#to "comment it out" or by substituting an entirely blank line.
edirprints remove, rename, and copy messages whereas
vidirprints messages only when the
-v/--verboseswitch is added. You can add
edirto suppress these messages.
vidiris run with the
-v/--verboseswitch then it reports the renaming of original to intermediate temporary to final files if files are swapped etc. That is rather an implementation detail so
edironly reports the original to final renames which is all the user really cares about.
To remove a large recursive tree you must pipe the directory tree to
vidirand then explicitly remove all children files and directories before deleting a parent directory. You can do this also in
edirof course (and arguably it is probably the safest approach) but there are times when you really want to let
edirremove recursively so
-r/--recurseswitch to allow this. BE CAREFUL USING THIS!
vidiralways shows all files and directories in a directory, including hidden files and directories (i.e. those starting with a
.). Usually a user does not want to be bothered with these so
edirby default does not show them. They can be included by adding the
edirdoes not require the user to specify the
-if something has been piped to standard input. E.g. you need only type
find | ediras opposed to
find | edir -. Note that
vidirrequires the second form.
-F/--filesoption to only show files, or
-D/--dirsto only show directories.
-L/--nolinksoption to ignore symbolic links.
-d/--dirnamesoption to edit specified directory names directly, not their contents. I.e. this is like
ls -d mydircompared to
edirshows a message "No files or directories" if there is nothing to edit, rather than opening an empty file to edit.
edirfilters out any duplicate paths you may inadvertently specify on it's command line.
ediralways invokes a consistent duplicate renaming scheme. E.g. if you rename
dall to the same pre-existing name
a~2. Depending on order of operations,
vidiris not always consistent about this, E.g. sometimes it creates a
a~(this may be a bug in
vidirthat nobody has ever bothered to report/address?).
edircreates the temporary editing file with a
.shsuffix so your EDITOR may syntax highlight the entries. Optionally, you can change this default suffix.
edirprovides an optional environment value to add custom options to the invocation of your editor. See section below.
edirprovides an optional configuration file to set default
edircommand line arguments. See section below.
Contrary to what it's name implies,
vidiractually respects your
$EDITORvariable and runs your preferred editor like
edirhas been given a generic name to make this more apparent.
ediris very strict about the format of the lines you edit and immediately exits with an error message (before changing anything) if you format one of the lines incorrectly. All lines in the edited list:
- Must start with a number and that number must be in range.
- Must have at least one white space/tab after the number,
- Must have a remaining valid path name.
- Can start with a
#or be completely blank to be considered the same as deleted.
Note the final edited order of lines does not matter, only the first number value is used to match the newly edited line to the original line so an easy way to swap two file names is just to swap their numbers.
ediralways actions files consistently. The sequence of operations applied is:
Deleted files are removed and all renamed files and directories are renamed to temporaries. The temporaries are made on the same file-system as the target.
Empty deleted directories are removed.
Renamed temporary files and directories are renamed to their target name. Any required copies are created.
Remaining deleted directories are removed.
In simple terms, remember that files are processed before directories so you can rename files into a different directory and then delete the original directory, all in one edit.
Renames and Deletes in a GIT Repository
When working within a Git repository, you nearly
always want to use
git mv instead of
git rm instead of
for files and directories so
edir recognises this and does it
automatically. Note that only tracked files/dirs are moved or renamed
using Git. Untracked files/dirs within the repository are removed or
renamed in the normal way.
If for some reason you don't want automatic git action then you can
--no-git option as a default option, see the section below on
how to set default options. If you set
--no-git as the default, then
you can use
-g/-git on the command line to turn that default option
Given how easy
edir facilitates deleting files, some users may prefer
to delete them to system
from where they can be later listed and/or recovered. Specifying
-t/--trash does this by executing the
trash-put command, from the
trash-cli package, to
remove files rather than removing them natively.
You may want to set
-t/--trash as a default option. If you do so then
you can use
-T on the command line to turn that default option off
Arch users can install edir from the AUR.
Python 3.6 or later is required. Note edir is on PyPI so you can just do:
$ sudo pip3 install edir
or, to install from this source repository:
$ git clone http://github.com/bulletmark/edir $ cd edir $ sudo pip3 install .
Optionally, if you are using an odd system and/or want to install this
manually then all you need to do is rename
edir and make
it executable somewhere in your path.
EDIR_EDITOR Environment Variable
edir selects your editor from the first environment value found of:
$EDITOR, then falls back to "vi" if
none of these are set.
You can also
EDIR_EDITOR explicitly to an editor + arguments
string if you want
edir to call your editor with specific arguments.
EDIR Command Default Arguments
You can add default arguments to a personal configuration file
~/.config/edir-flags.conf. If that file exists then each line of arguments
will be concatenated and automatically prepended to your
This allow you to set default preferred starting arguments to
edir -h to see the arguments supported.
--suffix, are sensible candidates to consider setting as default. If
you set these then "on-the-fly" negation options
-T, are also provided to temporarily override and disable default
options on the command line.
Rename and/or delete any files and directories in the current directory:
Rename and/or delete any jpeg files in current dir:
$ edir *.jpg
Rename and/or delete any files under current directory and subdirectories:
$ find | edir -F
fd to view and
repository files only, in the current directory only:
$ fd -d1 -tf | edir -g
Command Line Options
usage: edir [-h] [-a] [-A] [-r] [-R] [-q] [-Q] [-G] [-g] [-d] [-t] [-T] [-F | -D] [-L] [--suffix SUFFIX] [args [args ...]] Program to rename, remove, or copy files and directories using your editor. Will use git to action the rename and remove if run within a git repository. positional arguments: args file|dir, or "-" for stdin optional arguments: -h, --help show this help message and exit -a, --all include all (including hidden) files -A, --no-all negate the -a/--all/ option -r, --recurse recursively remove any files and directories in removed directories -R, --no-recurse negate the -r/--recurse/ option -q, --quiet do not print rename/remove/copy actions -Q, --no-quiet negate the -q/--quiet/ option -G, --no-git do not use git if invoked within a git repository -g, --git negate the --no-git option and DO use automatic git -d, --dirnames edit given directory names directly, not their contents -t, --trash use trash-put (from trash-cli) to do deletions -T, --no-trash negate the -t/--trash/ option -F, --files only show/edit files -D, --dirs only show/edit directories -L, --nolinks ignore all symlinks --suffix SUFFIX specify suffix for editor file, default=".sh" Note you can set default starting arguments in ~/.config/edir-flags.conf. The negation options (i.e. the --no-* options and their shortforms) allow you to temporarily override your defaults.
Embed in Ranger File Manager
In many ways
vidir) is better than the
command which does not handle name swaps and clashes etc. To add
as a command within ranger, add or create
the following in
~/.config/ranger/commands.py. Then run it from within
ranger by typing
from ranger.api.commands import Command class edir(Command): ''' :edir [file|dir] Run edir on the selected file or dir. Default argument is current dir. ''' def execute(self): self.fm.run('edir -q ' + self.rest(1)) def tab(self, tabnum): return self._tab_directory_content()
Copyright (C) 2019 Mark Blakeney. This program is distributed under the terms of the GNU General Public License. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License at http://www.gnu.org/licenses/ for more details.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size edir-2.6.2.tar.gz (13.6 kB)||File type Source||Python version None||Upload date||Hashes View|