Skip to content

Command Line Interface

Elijah Lopez edited this page Dec 24, 2024 · 2 revisions

Usage

When command-line arguments are used, Music Caster does not check for updates and thus will not auto-update. This ensures that using command-line arguments does what the user wants immediately without delays or restarts. If you want to allow Music Caster to update before processing the arguments, you can use --update.

NOTE: since this app is Windowed (on Windows), there is no terminal stdout/stderr. If you want responses, use the REST API.

If you want to play System Audio, it must be the only URI argument.

usage: "Music Caster[.exe]" [-h] [--debug] [--start-playing] [--queue] [--playnext] [--urlprotocol]
                            [--update] [--nupdate] [--exit] [--minimized] [--version] [--position POSITION]   
                            [--shell] [--device DEVICE]
                            [uris ...]

Music Caster

positional arguments:
  uris                 list of files/dirs/playlists/urls/"System Audio" to play/queue

options:
  --debug, -d          allows more than one music caster instance and no telemetry
  --start-playing      resume or shuffle play all
  --queue, -q          uris are queued rather than immediately played
  --playnext, -n       paths are added to "next up"
  --urlprotocol        launched using uri protocol
  --update, -u         allow music caster to update when other CLI args are provided
  --nupdate            start without auto-update
  --exit, -x           exits any existing instance (including self)
  --minimized, -m      start minimized to tray
  --position POSITION  position to start at if resume_playing
  --shell              if from shell/explorer
  --device DEVICE      select device to use (cast UUID or "local")

Example

"Music Caster" -q "C:\Users\maste\Music" "E:\Music\Adam K & Soha - Twilight.mp3" "favourite playlist" -m
Clone this wiki locally