Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clickwheel.fm/llms.txt

Use this file to discover all available pages before exploring further.

​
doctor

clickwheel plex doctor [OPTIONS]
Probe your Plex config end-to-end. Reports each stage (config, plexapi install, server connect, music section lookup, sample-track resolution) so failures point at exactly what’s broken. Examples 
# Diagnose the Plex connection (five stages)
clickwheel plex doctor

​
list

clickwheel plex list [OPTIONS]
List every audio playlist on your Plex server, with kind and size. Examples 
# List Plex audio playlists
clickwheel plex list

​
pull

clickwheel plex pull [OPTIONS] NAME
Pull a playlist from Plex back into clickwheel’s local store. For recovering hand-curated playlists after a clean install (Plex keeps them server-side; clickwheel’s catalog didn’t). Tracks are matched against your library; unmatched ones are reported so you can chase them. Examples 
# Import a Plex playlist into clickwheel
clickwheel plex pull road-trip
​
name
string
required
Plex playlist to pull into clickwheel.
​
--include-smart
boolean
Allow pulling a smart playlist (freezes a snapshot).
​
--overwrite
boolean
Replace an existing clickwheel playlist with the same name.

​
sync-plex

clickwheel sync-plex [OPTIONS] [PLAYLIST_NAME]
Push playlist(s) to your Plex music library. Examples 
# Push one playlist to Plex
clickwheel sync-plex road-trip

# Push every clickwheel playlist
clickwheel sync-plex --all
​
playlist_name
string
Playlist to push to Plex. Omit with —all to push every playlist.
​
--all
boolean
Push every clickwheel playlist to Plex.
​
--no-scan
boolean
Skip automatic library scan.