CrossRename 1.2.0

Harmonize file and directory names for Linux and Windows.

Harmonize file and directory names for Linux and Windows.

Explore the repo »

Table of Contents

• Introduction

• Features

• Installation

• Usage

  • Examples

  • Safety First

• Why did I build this?

• Contributing

• Wait a minute, who are you?

• License

• Changelog

Introduction

CrossRename is a command-line tool designed to harmonize file and directory names across Linux and Windows systems. It ensures that your file names are compatible with both operating systems, eliminating naming conflicts when transferring files between different environments.

back to top

Features

• Sanitizes file names to be Windows-compatible (and thus Linux-compatible)

• NEW: Optionally renames directories to be cross-platform compatible

• Handles both individual files and entire directories

• Supports recursive renaming of files in subdirectories

• Preserves file extensions, including compound extensions like .tar.gz

• Provides informative logging

• Provides a dry-run mode to preview renaming changes without executing them

• Interactive safety warnings with option to skip for automation

• Skips recursive symlinks to avoid infinite loops

back to top

Installation

From PyPI (Using PIP)

pip install CrossRename

back to top

Usage

usage: crossrename [-h] [-p PATH] [-v] [-u] [-r] [-d] [-D] [--force] [--credits]

CrossRename: Harmonize file and directory names for Linux and Windows.

options:
  -h, --help                  show this help message and exit
  -p, --path PATH             The path to the file or directory to rename.
  -v, --version               Prints out the current version and quits.
  -u, --update                Check if a new version is available.
  -r, --recursive             Rename all files in the directory path given and its subdirectories. When used with -D, also renames subdirectories.
  -d, --dry-run               Perform a dry run, logging changes without renaming.
  -D, --rename-directories    Also rename directories to be cross-platform compatible. Use with caution!
  --force                     Skip safety prompts (useful for automated scripts)
  --credits                   Show credits and support information

back to top

Examples

Rename a single file:

crossrename -p /path/to/file.txt

Rename all files in a directory (and its subdirectories):

crossrename -p /path/to/directory -r

Rename all files AND directories recursively:

crossrename -p /path/to/directory -r -D

Rename a single directory:

crossrename -p /path/to/problematic_directory -D

Perform a dry run to preview renaming changes without executing them:

crossrename -p /path/to/directory -r -D -d

Skip safety prompts for automated scripts:

crossrename -p /path/to/directory -r -D --force

Check for an update:

crossrename -u

Show credits and project information:

crossrename --credits

back to top

Safety First

Warning

Always run with --dry-run first!

CrossRename will show interactive safety warnings before making any changes to help prevent accidental data loss. However, it’s strongly recommended to:

1. Run a dry run first to preview what will be changed:

   crossrename -p /your/path -r -D -d

2. Backup your data before running the tool on important files

3. Use --force flag for automation in CI/CD pipelines:

   crossrename -p /build/output -r -D --force

Directory renaming is particularly powerful and potentially disruptive since it changes folder paths that other applications might reference.

back to top

Why did I build this?

Warning

I’m no longer dual booting. I’m using Windows 11 now. I do have WSL2 and that’s what I use for testing. I don’t know if there’ll be any difference in the way the tool works on a native Linux system.

So I was dual-booting Windows 10 and Lubuntu 22.04, and one day I’m trying to move some files between the two systems. Five files just wouldn’t copy over because of what I later found out were the differences in Windows and Linux’s file naming rules.

That got me thinking because I’d already built a Python package that had to deal with some file creation and renaming ( It’s called FicImage please check it out 🫶) before, so I had an idea or two about how to go about this.

Long story short, I got annoyed enough to build CrossRename. Now I don’t have to deal with file naming headaches when switching between systems.

back to top

Contributing

Contributions are welcome! If you’d like to improve CrossRename or add support for other operating systems (like macOS), please feel free to submit a pull request.

back to top

Wait a minute, who are you?

Hello there! I’m Emmanuel Jemeni, and while I primarily work as a Frontend Developer, Python holds a special place as my first programming language. You can find me on various platforms:

• LinkedIn

• GitHub

• BlueSky

• Twitter/X

back to top

License

MIT License

back to top

Changelog

Changelog

back to top