A simple command-line utility to synchronize watched / seen status between different Plex Media Servers.
- Syncs watch status between different Plex servers.
- NodeJS 4+
plex-sync is installed via NPM:
$ npm install -g plex-sync
There are several available configuration environment variables:
||The API token used to access your Plex server. To locate this token, follow the instructions here, or use this bookmarklet. The Plex token must be set on the arguments or via the environment variable.|
||Set this environment variable to make
||Can be either
First, find the IDs for the libraries on each server you would like to sync. These IDs can be found at the end of the URL when viewing the library in your browser (like
Next, use the CLI as follows:
$ plex-sync [https://][token@]IP[:PORT]/SECTION[,rw] [https://][token@]IP[:PORT]/SECTION[,rw] [[https://][token@]IP[:PORT]/SECTION[,rw]...]
Sync watched status between two servers, using the default port (
32400), using library ID
1 for the first server and library
3 for the second:
$ plex-sync 10.0.1.5/1 10.0.1.10/3
Sync three servers, with different ports:
$ plex-sync 10.0.1.5:32401/1 10.0.1.5:32402/1 10.0.1.10/3
Sync with a server via HTTPS:
$ plex-sync 10.0.1.2/2 https://server-domain/3
Dry run, to see what the script will do:
$ DRY_RUN=1 plex-sync 10.0.1.5/1 10.0.1.5/1
Precise matching (slow and may crash the Plex server):
$ MATCH_TYPE=precise plex-sync 10.0.1.5/1 10.0.1.5/1
Syncing between multiple Plex users (different access tokens):
$ plex-sync firstname.lastname@example.org/1 email@example.com/3
Unidirectional sync (read from one server, write to the other):
$ plex-sync 10.0.1.5/1,r 10.0.1.10/3,w
Complex use case:
$ plex-sync firstname.lastname@example.org:32401/1,r https://email@example.com/3,w firstname.lastname@example.org/2,rw
For more complex strategies, like syncing between multiple different library mappings, just run the tool multiple times. If you need to run the synchronization on a schedule, use another scheduling tool like cron. These more advanced features may be added in the future, but currently
plex-sync is very simple.
Contributions are welcome. Open a pull request or issue to contribute.
MIT license. See
LICENSE for more information.