plexlists

plexlists

Command-line tool for syncing folder-based playlists in Plex

Features

• ✅ Sync playlists from folders - Folder name becomes playlist name
• ✅ Update existing playlists - Automatic update of playlists on content change
• ✅ Batch processing - Sync multiple folders at once
• ✅ Config file - Store credentials once
• ✅ Symlink support - Works with symlinked files

Installation

Via npm

npm install -g plexlists
plexlists --help

From source

git clone https://github.com/dhowe/plexlists.git
cd plexlists
npm install
npm link
plexlists --help

Quick Start

# 1. Configure
plexlists config set \
  --host=192.168.1.100 \
  --port=32400 \
  --token=YOUR_PLEX_TOKEN \
  --library=Music

# 2. Test connection
plexlists test

# 3. Sync playlists
plexlists sync ~/Music/Playlists/*

Configuration

Config file format

{
  "host": "192.168.1.100",
  "port": 32400,
  "token": "YOUR_PLEX_TOKEN",
  "library": "Music",
  "timeout": 60000
}

Fields:

• host (required) - Plex server hostname or IP
• port (optional) - Server port (default: 32400)
• token (required) - Plex authentication token (how to find)
• library (optional) - Default library name (e.g., "Music", "Movies")
• timeout (optional) - Request timeout in ms (default: 60000)

Config file locations (priority order)

• --config flag - Explicit path
• PLEXLISTS_CONFIG env var
• ./.plexlists-conf.json - Project-specific
• ~/.plexlists-conf.json - User default

See examples/ for sample configs and docs/CONFIG_PRIORITY.md for details.

Usage

Sync playlists

# Sync all playlists (library from config)
plexlists sync ~/Music/Playlists/*

# Override library
plexlists sync ~/Movies/Playlists/* --library=Movies

# Dry run (preview changes)
plexlists sync ~/Music/Playlists/* --dry-run

# Verbose logging
plexlists sync ~/Music/Playlists/* --verbose

Config management

# Show config
plexlists config show

# Set config
plexlists config set --host=X --token=Y --library=Music

# Show config path
plexlists config path

Test connection

plexlists test

Automation

Cron example (daily at 2 AM)

crontab -e

Add:

0 2 * * * cd /home/user/music-project && plexlists sync Playlists/* >> /var/log/plexlists.log 2>&1

systemd timer (Linux)

Create /etc/systemd/system/plexlists.service:

[Unit]
Description=Sync Plex playlists

[Service]
Type=oneshot
User=your-user
WorkingDirectory=/home/your-user/music-project
ExecStart=/usr/local/bin/plexlists sync Playlists/*

Create /etc/systemd/system/plexlists.timer:

[Unit]
Description=Sync Plex playlists daily

[Timer]
OnCalendar=daily
Persistent=true

[Install]
WantedBy=timers.target

Enable:

sudo systemctl enable --now plexlists.timer

Folder Structure Example

~/Music/
  ├── Library/              # Your actual music files
  │   ├── Artist 1/
  │   │   ├── track1.mp3
  │   │   └── track2.mp3
  │   └── Artist 2/
  │       └── track3.mp3
  │
  └── Playlists/            # Playlist folders (symlinks)
      ├── Favorites/
      │   ├── track1.mp3 -> ~/Music/Library/Artist 1/track1.mp3
      │   └── track3.mp3 -> ~/Music/Library/Artist 2/track3.mp3
      │
      ├── Workout/
      │   └── track2.mp3 -> ~/Music/Library/Artist 1/track2.mp3
      │
      └── Chill/
          ├── track1.mp3 -> ~/Music/Library/Artist 1/track1.mp3
          └── track2.mp3 -> ~/Music/Library/Artist 1/track2.mp3

Sync:

cd ~/Music
plexlists sync Playlists/*

Result in Plex:

• Playlist "Favorites" with 2 tracks
• Playlist "Workout" with 1 track
• Playlist "Chill" with 2 tracks

Documentation

• Finding Plex Token
• Finding Host & Port
• Config Priority Guide
• Publishing to npm

Troubleshooting

"Error: Plex token not configured"

plexlists config set --token=YOUR_TOKEN

"Connection failed"

• Check config: plexlists config show
• Test connection: plexlists test
• Verify Plex server is running and accessible
• Check firewall settings

"No tracks found"

• Verify folder contains audio files
• Check symlinks are not broken: ls -la folder/
• Enable verbose logging: --verbose
• Ensure Plex has scanned the library

Which config is being used?

plexlists config path   # Show active config file
plexlists config show   # Show config contents

Related Projects

• Plex Folder Playlist Creator (GUI) - Electron desktop app with same functionality

Credits

Based on code by Zack Dawood (https://github.com/zackria)

License

MIT - See LICENSE

Contributing

Issues and pull requests welcome!

Support

• GitHub Issues
• Original Project