Batch File Renamer CLI

🚀 Lightweight and fast CLI tool for batch file renaming with pattern support.

✨ Features

• ✅ Prefix/Suffix Support - add prefixes or suffixes to filenames
• 🔄 Extension Change - change file extensions easily
• 🎯 Regex Patterns - use sed regex patterns for complex renaming
• 🔍 Dry Run Mode - preview changes without actually renaming
• 📊 Verbose Output - detailed information about operations
• 🛡️ Safe Operations - checks for conflicts and permissions
• ⚡ Fast Startup - single bash script, no dependencies
• 🎨 Colored Output - beautiful terminal interface

🛠️ Installation

Quick Installation (Recommended)

# Clone the repository
git clone https://github.com/mrvi0/batch-file-renamer.git
cd batch-file-renamer

# Install to system
sudo ./install.sh

Manual Installation

# Make script executable
chmod +x batch-rename

# Copy to system directory
sudo cp batch-rename /usr/local/bin/

🚀 Usage

Basic Usage

# Add prefix to files
batch-rename --prefix "photo_" *.jpg

# Add suffix to files
batch-rename --suffix "_backup" *.txt

# Change file extension
batch-rename --ext "md" *.txt

# Use regex pattern
batch-rename --regex "s/document/doc/g" *.txt

Command Line Options

# Dry run (preview changes)
batch-rename --prefix "new_" --dry-run *.txt

# Verbose mode
batch-rename --prefix "test_" --verbose *.txt

# Combine operations
batch-rename --prefix "backup_" --suffix "_$(date +%Y%m%d)" *.log

# Full help
batch-rename --help

Usage Examples

1. Add Prefix to Files

batch-rename --prefix "photo_" *.jpg

Output:

🔄 Starting batch rename operation...

✅ Renamed: image1.jpg → photo_image1.jpg
✅ Renamed: image2.jpg → photo_image2.jpg
✅ Renamed: vacation.jpg → photo_vacation.jpg

📊 Rename summary:
   Successfully renamed: 3 files

2. Add Suffix with Date

batch-rename --suffix "_$(date +%Y%m%d)" *.log

Output:

🔄 Starting batch rename operation...

✅ Renamed: app.log → app_20241201.log
✅ Renamed: error.log → error_20241201.log

📊 Rename summary:
   Successfully renamed: 2 files

3. Change File Extension

batch-rename --ext "md" *.txt

Output:

🔄 Starting batch rename operation...

✅ Renamed: readme.txt → readme.md
✅ Renamed: changelog.txt → changelog.md

📊 Rename summary:
   Successfully renamed: 2 files

4. Regex Pattern Replacement

batch-rename --regex "s/document/doc/g" *.txt

Output:

🔄 Starting batch rename operation...

✅ Renamed: document1.txt → doc1.txt
✅ Renamed: document2.txt → doc2.txt

📊 Rename summary:
   Successfully renamed: 2 files

5. Dry Run Mode

batch-rename --prefix "test_" --dry-run *.txt

Output:

🔄 Starting batch rename operation...
🔍 DRY RUN MODE - No files will be actually renamed

📝 Would rename: file1.txt → test_file1.txt
📝 Would rename: file2.txt → test_file2.txt

📊 Dry run summary:
   Files that would be renamed: 2
   Errors: 0

6. Verbose Mode

batch-rename --prefix "final_" --verbose *.txt

Output:

🔧 Operation Summary:
   Prefix: final_
   Files to process: 3

🔄 Starting batch rename operation...

✅ Renamed: draft.txt → final_draft.txt
✅ Renamed: notes.txt → final_notes.txt
✅ Renamed: temp.txt → final_temp.txt

📊 Rename summary:
   Successfully renamed: 3 files

7. Complex Regex Pattern

batch-rename --regex "s/^([0-9]+)/file_\1/g" *.txt

Output:

🔄 Starting batch rename operation...

✅ Renamed: 001.txt → file_001.txt
✅ Renamed: 002.txt → file_002.txt
✅ Renamed: 100.txt → file_100.txt

📊 Rename summary:
   Successfully renamed: 3 files

🧪 Testing

Run tests to verify functionality:

chmod +x test.sh
./test.sh

Tests verify:

• Help and version commands
• Argument validation
• Prefix operations
• Suffix operations
• Extension changes
• Regex patterns
• Dry run mode
• Verbose mode
• Error handling
• File operations

📁 Project Structure

batch-file-renamer/
├── batch-rename         # Main bash script
├── install.sh           # Installation script
├── uninstall.sh         # Uninstall script
├── test.sh              # Test suite
├── examples/
│   └── sample_files.txt # Example usage
├── README.md           # Documentation
├── README_RU.md        # Russian documentation
├── LICENSE             # MIT license
└── .gitignore          # Ignored files

🔧 Technical Details

Dependencies

• bash 4.0+ - command line interpreter
• sed - for regex operations (usually pre-installed)

Main Functions

• generate_new_name() - create new filename based on rules
• rename_files() - perform batch rename operations
• validate_args() - validate command line arguments
• check_file() - verify file existence and permissions

Supported Operations

• Prefix: Add text before filename
• Suffix: Add text before extension
• Extension: Change file extension
• Regex: Use sed patterns for complex replacements

Safety Features

• Dry run mode for preview
• Conflict detection (existing files)
• Permission checking
• File existence validation
• Regex pattern validation

🎯 Use Cases

Photo Organization

# Add date prefix to photos
batch-rename --prefix "$(date +%Y%m%d)_" *.jpg

# Add location suffix
batch-rename --suffix "_paris" *.jpg

Document Management

# Convert text files to markdown
batch-rename --ext "md" *.txt

# Add version suffix
batch-rename --suffix "_v2.0" *.md

Backup Operations

# Create dated backups
batch-rename --prefix "backup_" --suffix "_$(date +%Y%m%d)" *.log

# Add timestamp
batch-rename --suffix "_$(date +%H%M%S)" *.conf

File Cleanup

# Remove unwanted prefixes
batch-rename --regex "s/^temp_//g" *.tmp

# Standardize naming
batch-rename --regex "s/^([0-9]+)/chapter_\1/g" *.txt

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Inspired by the need for a simple, lightweight file renaming tool
• Built with bash for maximum compatibility
• Designed for Unix/Linux environments