streampal-connect

The one-command agent that links your OBS to your StreamPal dashboard and phone stream deck.

npx streampal-connect <your-pair-code>

Find your pair code on your dashboard at streampal.gg → OBS.

It:

• auto-detects OBS on this PC (ws://127.0.0.1:4455) — asks for the OBS WebSocket password once, then remembers it,
• connects outbound to StreamPal's relay, so your home network needs no port-forwarding or firewall changes,
• bridges the two: buttons on your dashboard / phone run against OBS here.

Leave the window open while you stream. Ctrl+C to stop. Next time it's just npx streampal-connect — your code and password are saved to ~/.streampal/connect.json (that file never leaves your machine).

Options

| Flag | Meaning | | --- | --- | | --relay <wss://…> | Use a different relay (default: StreamPal's public relay) | | --obs-url <ws://…> | OBS WebSocket URL (default ws://127.0.0.1:4455) | | --obs-password <pw> | Pass the OBS password non-interactively | | --reset | Forget saved settings and set up fresh | | --help | Show help |

Environment variables STREAMPAL_PAIR_CODE, STREAMPAL_RELAY_URL, OBS_PASSWORD are also honoured.

First-time OBS setup

In OBS: Tools → WebSocket Server Settings → Enable WebSocket server. Note the password (Show Connect Info). That's the only thing you paste besides your pair code.