github.com/cryptix/massren@v1.0.1/README.md (about)

     1  ## Massren
     2  
     3  Massren is a command line tool that can be used to rename multiple files using your own text editor. Multiple rename tools are usually difficult to use from the command line since any regular expression needs to be escaped, and each tool uses its own syntax and flavor of regex. The advantage of massren is that you are using the text editor you use every day and so can use all its features.
     4  
     5  The tool works by creating a file that contains the filenames of the target directory, and opening this file in the text editor. You can then modify the filenames there directly. Once done, save the text file and the files will be renamed. Lines that are not changed will simply be ignored.
     6  
     7  ## Features
     8  
     9  - Rename multiple files using your text editor.
    10  
    11  - Safety checks - since this is a multiple rename tools, various checks are in place to ensure that nothing gets accidentally renamed. For example, the program will check that the files are not being changed by something else while the list of filenames is being edited. If the number of files before and after saving the file is different, the operation will also be cancelled.
    12  
    13  - Undo - any rename operation can be undone.
    14  
    15  - Dry run mode - test the results of a rename operation without actually renaming any file.
    16  
    17  - Cross-platform - Windows, OSX and Linux are supported.
    18  
    19  ## Installation
    20  
    21  ### OSX
    22  
    23  	brew install massren
    24  	
    25  ### Linux
    26  
    27  	sudo apt-get install massren
    28  	
    29  ### Windows
    30  
    31  	Download the executable from: 
    32  	
    33  ## Usage and examples
    34  
    35  	Usage:
    36  	  massren [OPTIONS] [path]
    37  
    38  	Application Options:
    39  	  -n, --dry-run  Don't rename anything but show the operation that would have been performed.
    40  	  -v, --verbose  Enable verbose output.
    41  	  -c, --config   Set a configuration value. eg. massren --config <name> [value]
    42  	  -u, --undo     Undo a rename operation. eg. massren --undo [path]
    43  	  -V, --version  Displays version information.
    44  
    45  	Help Options:
    46  	  -h, --help     Show this help message
    47  
    48  	Examples:
    49  
    50  	  Process all the files in the current directory:
    51  	  % massren
    52  
    53  	  Process all the JPEGs in the specified directory:
    54  	  % massren /path/to/photos/*.jpg
    55  
    56  	  Undo the changes done by the previous operation:
    57  	  % massren --undo /path/to/photos/*.jpg
    58  
    59  	  Set VIM as the default text editor:
    60  	  % massren --config editor vim
    61  
    62  ## TODO
    63  
    64  - Detect default text editor on Windows.
    65  - Detect default text editor on POSIX systems.
    66  - Disambiguate filenames when processing two or more folders that contain the same filenames.
    67  
    68  ## License
    69  
    70  MIT