Renamer Core

Command line tool to rename movie and show files for Plex.

Installation

Requires .NET 6

Clone the repo to you computer. Pull to get updates. Open a command prompt to the source directory.

If you are updating, remove the old version first:

> dotnet tool uninstall -g renamer-core

To install:

> dotnet build
> dotnet pack
> dotnet tool install -g --add-source ./dist renamer-core

Usage

There are 3 commands: config, m, and s. The last two are the Movie Renamer and the Show Renamer, respectively.

The config command

The config command is used to set the API key for The Movie DB API. You will need to get your own API key.

> renamer config -tmdb <APIKEY>

Config values are stored in a JSON file in your local app storage directory (~\AppData\Local on Windows, ~/.config on *nix).

Movie Renamer

renamer m [OPTIONS]

The Movie Renamer looks for any files in the input directly, runs them through a simple search algorithm against The Movie Database, then names them in a way that Plex likes.

For instance, given a file called star.wars.1977.h264.foo.bar.mkv, it will match against The Movie DB and rename the file to Star Wars (1977).mkv. Special tags will be added for 4k and 1080p movies if the original file name indicates the resolution. Subtitle files (srt and sub extensions) are treated as English, and .en will be inserted before the extension.

New in 3.2: If the movie year prefixes the title, the year will be dropped before searching.

Movie Renamer Options

• -i <PATH> or --input <PATH> - Input Directory. Defaults to current directory.
• -o <PATH> or --output <PATH> - Output Directory. Defaults to the input directory.
  • Note that files will be moved if the input and output directories are not the same.
• -y or --yes - Skip Confirmation. If provided, the confirmation prompt before renaming will be skipped. Be aware that files will be renamed (and possibly moved) immediately after matches are made.
• --verbose - Verbose Output. Will show search queries as they are made, as well as other extra output.

Show Renamer

renamer s [OPTIONS]

The Show Renamer looks for any files in the input directly, attempts to match the show/season/episode to The Movie DB, then moves the files to a folder structure that Plex likes.

For instance, given a file called doctor.who.2005.s01e01.mkv, it will be moved to Doctor Who (2005)\Season 01\Doctor Who (2005) - s01e01 - Rose.mkv. In order for the episode to be matched correctly, the season and episode must be in the file name using sXXeYY or YYxZZ. Any text before the season/episode info is considered to be the show name and is searched against The Movie DB using a similar algorithm to the movie renamer.

NEW! In 2.4+, you can now prepend the show ID from The Movie DB to the beginning of the filename. Wrap it in double-square brackets to override the show name search. For example, you can name the file something like [[12345]]some.show.name.s01e01.mkv to have the show matched directly based on the ID 12345.

Show Renamer Options

• -i <PATH> or --input <PATH> - Input Directory. Defaults to current directory.
• -o <PATH> or --output <PATH> - Output Directory. Defaults to the input directory.
  • Note that files will be moved if the input and output directories are not the same.
• -f or --files-only - Files Only Mode. Will not create folders for shows or seasons. Only the files will be renamed. They may still be moved to the output directory.
• -r or --recurse - Recursive Mode. Will recursively scan all folders and subfolders to find files in the Input Directory.
• -y or --yes - Skip Confirmation. If provided, the confirmation prompt before renaming will be skipped. Be aware that files will be renamed (and possibly moved) immediately after matches are made.
• --verbose - Verbose Output. Will show search queries as they are made, as well as other extra output.