A command-line interface for MoonDeck that allows you to manage and control game streaming hosts from the terminal. This CLI provides functionality to scan for hosts, pair with them, launch games, and manage streaming sessions without needing the Steam Deck UI.
Warning
Archived as MoonDeck implements CLI
- 🔍 Host Discovery: Automatically scan for available Apollo/Sunshine hosts on your network
- 🔗 Host Pairing: Pair with hosts using PIN-based authentication
- 🎮 Game Launching: Launch Steam games and non-Steam applications remotely
- 📱 Stream Management: Monitor and control active streaming sessions
- 💾 Host Management: Save, list, and manage multiple host configurations
- 🌐 Wake-on-LAN: Wake up sleeping hosts remotely
- ⚙️ Configuration: Flexible configuration with support for custom config files
- MoonDeck Buddy: Install MoonDeck Buddy on your host PC
- Python 3.7+: Required to run the CLI
- Network Access: Ensure your client and host are on the same network or have proper network connectivity
-
Clone this repository:
git clone https://github.com/ClassicOldSong/moondeck-cli.git cd moondeck-cli -
Initialize the MoonDeck submodule:
git submodule update --init --recursive
-
Download the cretificate file from https://github.com/FrogTheFrog/moondeck-keys/blob/main/moondeck_cert.pem and save to
./moondeck/defaults/python/ssl/moondeck_cert.pem. -
Run the CLI:
python moondeck-cli.py --help
-
Scan for hosts:
python moondeck-cli.py scan
-
Pair with a host:
python moondeck-cli.py pair --host <HOST_IP_OR_ID_OR_HOST_NAME> --pin 1234
-
Set a default host (optional):
python moondeck-cli.py set-default <HOST_ID>
-
Launch a game:
python moondeck-cli.py launch --app-id <STEAM_APP_ID>
Scan for available MoonDeck Buddy hosts on the network and update the local hosts database.
python moondeck-cli.py scan [--timeout SECONDS]Options:
--timeout: Scan timeout in seconds (default: 5.0)
Pair with a MoonDeck Buddy host using PIN authentication.
python moondeck-cli.py pair --host <HOST> --pin <PIN> [OPTIONS]Options:
--host: Host ID, IP address, or hostname--pin: 4-digit pairing PIN (default: random)--port: Buddy port (default: 59999)--client-id: Custom client ID--no-default: Don't set this host as default after pairing
Display all saved hosts with their configuration details.
python moondeck-cli.py list-hostsSet a host as the default for commands that don't specify a host.
python moondeck-cli.py set-default <HOST_ID>Clear the current default host setting.
python moondeck-cli.py clear-defaultWake a host using Wake-on-LAN (requires MAC address).
python moondeck-cli.py wake [--host <HOST>]Launch a Steam game on the specified host.
python moondeck-cli.py launch --app-id <APP_ID> [OPTIONS]Options:
--app-id: Steam application ID (required)--host: Target host (uses default if not specified)--port: Buddy port (default: 59999)--client-id: Custom client ID--no-big-picture: Launch without Big Picture mode--wait: Wait for the game to quit and automatically end the stream
List available GameStream applications on a host.
python moondeck-cli.py list-apps [--host <HOST>]List non-Steam games available on a host.
python moondeck-cli.py list-non-steam --user-id <USER_ID> [--host <HOST>]Options:
--user-id: Steam user ID (required)
Get information about the currently running application on a host.
python moondeck-cli.py app-status [--host <HOST>]End the current game stream on a host.
python moondeck-cli.py end-stream [--host <HOST>]The CLI uses JSON configuration files to store settings and host information:
- config.json: Main configuration file containing client ID, default host, and hosts file path
- hosts.json: Database of discovered and paired hosts
- Script mode: Same directory as
moondeck-cli.py
You can specify a custom configuration file location:
python moondeck-cli.py --config-file /path/to/custom/config.json <command>config.json:
{
"client_id": "unique-client-identifier",
"hosts_file": "hosts.json",
"default_host": "host-id-or-null"
}hosts.json:
{
"HOST_ID": {
"id": "HOST_ID",
"uniqueId": "unique-host-identifier",
"hostName": "Host Display Name",
"address": "192.168.1.100",
"buddy_port": 59999,
"client_id": "paired-client-id",
"mac": "AA:BB:CC:DD:EE:FF"
}
}-
Discover hosts on your network:
python moondeck-cli.py scan
-
Pair with your gaming PC:
python moondeck-cli.py pair --host 192.168.1.100 --pin 1234
-
Set it as default:
python moondeck-cli.py set-default HOST_ID
-
Launch a game (e.g., Steam app ID 570 for Dota 2):
python moondeck-cli.py launch --app-id 570
Launch a game and wait for it to finish:
python moondeck-cli.py launch --app-id 570 --waitWake a sleeping host and launch a game:
python moondeck-cli.py wake --host gaming-pc
sleep 30 # Wait for host to boot
python moondeck-cli.py launch --app-id 570 --host gaming-pcCheck what's currently running:
python moondeck-cli.py app-statusEnd a stream session:
python moondeck-cli.py end-stream- "No hosts found": Ensure Apollo/Sunshine is running on the host and both devices are on the same network
- "Pairing failed": Check that the PIN is correct and the host is ready for pairing
- "Host not found": Verify the host ID/IP is correct using
list-hosts - "Missing MAC address": The host needs to be properly paired to store MAC address for Wake-on-LAN
The CLI generates logs in cli.log in the same directory as the script. Check this file for detailed error information.
- Port 59999: Default MoonDeck Buddy port (configurable)
- UDP Broadcast: Required for host discovery
- Wake-on-LAN: UDP port 9 for wake packets
- MoonDeck - Steam Deck plugin for game streaming
- MoonDeck Buddy - Host-side companion application
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.