torrent-renamer

A CLI tool/library for renaming torrent files.

Usage no npm install needed!

<script type="module">
  import torrentRenamer from 'https://cdn.skypack.dev/torrent-renamer';
</script>

README

torrentRenamer

DISCLAIMER

This project in no way endorses copyright infringement, and should only be used on videos that you legally own or otherwise have the right to have.

About

torrentRenamer uses the parse-torrent-title project to parse video filenames and rename them for better organization.

By default, videos are renamed to:

  • Movies: /path/to/home/Videos/Movies/{title} - ({year}).{extension}
  • TV Shows: /path/to/home/TV Shows/{series}/{series} - Season {season}/{series} - S{season}E{episode}.{extension}

Unfortunately, this cannot be changed via CLI or config quite yet, so to change, just change the following fields towards the top of bin/index.js:

  • movieFilenameFormat
  • showDirectoryFormat
  • showSeasonDirectoryFormat
  • showFilenameFormat

OMDB Support

There is support to use the OMDB API. To use it, all you will need to do is set OMDB_API_KEY=<your_key> environment variable prior to run (or inline).

When OMDB is used, it will use the title, season, episode, and year values that are returned from it, instead of from parse-torrent-title. It will also change the output filename of a TV Show to {series} = S{season}E{episode} - {title}.{extension} (notice the added episode title).