CLI Commands

Starting CLI Mode

slPhantomRemote.exe uimode:cli

This starts the interactive CLI with a sala> prompt.

CLI Commands (Interactive Mode)

When you're in CLI mode with the sala> prompt, these commands are available:

Discovery and Connection

Connect examples:

• Index: connect 2 (device [2] from discovery)
• IP: connect 192.168.1.100
• Name: connect "Gold Phantom-Left" or connect Dialog

Playback Control

Volume Control

Source Management

Source selection examples:

• Index: source 1 (source [1] from list)
• Name: source Spotify or source "My Music"
• ID: source source_id_xyz

Device Management

Advanced Features

System Commands

Command Line Mode (One-Shot Commands)

For automation, you can run single commands without entering interactive mode:

# Direct device control
slPhantomRemote.exe 192.168.1.100 -play
slPhantomRemote.exe 192.168.1.100 -pause
slPhantomRemote.exe 192.168.1.100 -volume 30
slPhantomRemote.exe 192.168.1.100 -mute
slPhantomRemote.exe 192.168.1.100 -playsource "Spotify"

# Discovery
slPhantomRemote.exe -discover

# GUI with auto-connect
slPhantomRemote.exe -connect 192.168.1.100

Available One-Shot Commands

Device Discovery and Connection

• -discover - Scan network for Phantom devices
• -connect <IP> - Open GUI connected to specific device
• -dump - Comprehensive network interrogation (all devices, all info)
• -testendpoints <IP> - Test which API namespace works with device

Playback Control

• <IP> -play - Play current source
• <IP> -pause - Pause playback
• <IP> -getnowplaying - Get current playing information

Volume Control

• <IP> -volup - Increase volume by 5%
• <IP> -voldown - Decrease volume by 5%
• <IP> -volume <level> - Set volume to specific level (0-100)
• -volup - Volume up on last connected device
• -voldown - Volume down on last connected device
• -mute - Toggle mute on last connected device

Source Management

• <IP> -getsourcelist - List all available sources
• <IP> -playsource <source> - Play source by index, ID, name, or type

Device Power Management

• <IP> -restart - Restart the Phantom device
• <IP> -poweroff - Power off the Phantom device

Examples

CLI Mode Session

# Discovery and connection
sala> discover
sala>=> Found 4 device(s):
  [0] 192.168.0.11         192.168.0.11
  [1] Arch-b               192.168.0.30
  [2] Gold Phantom-Right   192.168.0.33
  [3] Gold Phantom-Left    192.168.0.31    *

sala> connect 3                    # Connect by index
sala> connect "Gold Phantom-Left"  # Connect by name
sala> connect 192.168.0.31        # Connect by IP

# Source management
sala> sources
sala>=> Found 3 source(s):
  [0] Spotify (spotify)
  [1] My Music (upnp)
  [2] Optical (optical)

sala> source 0          # Select by index
sala> source Spotify    # Select by name
sala> source optical    # Select by type

# Favorites
sala> favorite          # Mark current device as favorite
sala>=> Added to favorites

# Quick aliases
sala> c 2               # connect to device [2]
sala> p                 # play
sala> v 50              # volume 50%
sala> +                 # volume up
sala> m                 # mute toggle

CMD Mode Examples

# Discover all devices on network
slPhantomRemote.exe -discover

# Connect GUI to specific device
slPhantomRemote.exe -connect 192.168.1.100

# Full network interrogation
slPhantomRemote.exe -dump

# Play/pause controls
slPhantomRemote.exe 192.168.1.100 -play
slPhantomRemote.exe 192.168.1.100 -pause

# Volume control
slPhantomRemote.exe 192.168.1.100 -volume 30
slPhantomRemote.exe 192.168.1.100 -volup

# Source selection
slPhantomRemote.exe 192.168.1.100 -getsourcelist
slPhantomRemote.exe 192.168.1.100 -playsource "My Spotify"
slPhantomRemote.exe 192.168.1.100 -playsource 0

# Device power management
slPhantomRemote.exe 192.168.1.100 -restart
slPhantomRemote.exe 192.168.1.100 -poweroff

# Quick actions on last device
slPhantomRemote.exe -volup
slPhantomRemote.exe -voldown
slPhantomRemote.exe -mute

# Explicit namespace usage
slPhantomRemote.exe 192.168.1.100 groups -play
slPhantomRemote.exe 192.168.1.100 systems -volume 25

Automation Example (PowerShell)

# Morning routine
slPhantomRemote.exe 192.168.1.100 -volume 20
slPhantomRemote.exe 192.168.1.100 -playsource spotify
slPhantomRemote.exe 192.168.1.100 -play

Advanced Usage

Namespace Selection

You can specify the namespace explicitly for devices that support multiple namespaces:

slPhantomRemote.exe <IP> <namespace> <operation>

Where namespace is: devices, systems, or groups

Source Selection Methods

The -playsource command supports multiple selection methods:

• Index number: 0, 1, 2... (based on source list order)
• Source ID: Full UUID
• Friendly name: User-configured name like "My Spotify"
• Source type: Generic type like "spotify", "airplay"

Network Interrogation (-dump)

The -dump command provides comprehensive information about all Phantom devices on your network, including:

• Device identification
• Group membership
• Current playback status
• Available sources
• Audio settings

This is particularly useful for debugging connectivity issues and understanding device capabilities.

Troubleshooting CLI Mode

If CLI mode doesn't start properly:

1. Make sure you're running from a command prompt (cmd.exe) or PowerShell
2. Try running with full path: C:\path\to\slPhantomRemote.exe uimode:cli
3. Check that .NET 8.0 Desktop Runtime is installed
4. If help shows Windows CMD help instead of app help, close and restart

Key Features

The CLI mode provides the same core functionality as the GUI: play/pause control, volume control, source switching, and device discovery.