NAME

plex-archiver - A script to archive Plex media files.

SYNOPSIS

plex-archiver --source-dir /path/to/plex/media --destination-dir /path/to/archive [options]

Options:
  --source-dir      The directory containing the Plex media to be archived.
  --destination-dir The directory where the media will be archived.
  --move            Move files (delete source after copy).
  --api-key         TMDB API key filename.
  --dry-run         Dry run; do not make any changes.
  --help            Show this help message.
  --man             Display the full documentation.

DESCRIPTION

plex-archiver is a command-line tool designed to facilitate the archiving of media files from a Plex Media Server. The script identifies media files within a specified source directory and moves them to a designated archive location. This is particularly useful for managing storage space by moving older or less frequently accessed media to a secondary storage device.

The core functionality will involve scanning the source directory, identifying files that meet certain criteria (to be implemented), and then safely transferring them to the destination directory.

OPTIONS

--api-key API_KEY_FILENAME

Specifies the file that contains the TMDB API key to use for retrieving details from the TMDB API.

--move

Specifies if the files should be moved to the new destination. This deletes the files from the source directory after copying to the new destination.

--dry-run

Say waht would happen without creating directories or copying / moving files.

--source-dir

Specifies the full path to the directory containing the Plex media files that are candidates for archiving. This is a mandatory option.

--destination-dir

Specifies the full path to the directory where the selected media files will be moved. This is a mandatory option.

--help

Prints a brief help message summarizing the command-line options and exits.

--man

Displays the complete manual page for the script, providing detailed information about its usage, description, and options.

EXAMPLES

To archive media from '/movies' to '/plex-media/movies':
plex-archiver --source-dir /movies --destination-dir /plex-media/movies
To archive media from '/movies' to '/plex-media/movies' and deleting:
plex-archiver --move --source-dir /movies --destination-dir /plex-media/movies