CLI Commands

Use built-in help for command syntax:

unleash-stream-cli --help

unleash-stream-cli COMMAND --help

Command Reference

For runtime semantics (retry behavior, continuous mode, persistence, and log retention), see Behavior Details.

`add`

Add a stream, start it immediately, and persist it for restoration on service restart.

unleash-stream-cli add SOURCE [OPTIONS]

Arguments:

Argument	Description
`SOURCE`	Source URL or file path (required)

Options:

Option	Short	Description
`--destination-url URL`	`-D`	Full Unleash live destination stream URL (alternative to `-d` and `-t`)
`--device DEVICE_ID`	`-d`	Unleash live device ID (e.g., `W123a4b5678c9de0`)
`--token TOKEN`	`-t`	Stream authorization token (e.g., `fluffy-black-dog-11`)
`--name NAME`	`-n`	Display name for this stream (defaults to device ID)
`--timeout SECS`		Source connection timeout (default: `30`)
`--max-retries N`		Maximum retry attempts (omit for unlimited)
`--continuous`	`-C`	Restart on any exit (including clean exits) until manually stopped

Source Examples:

# RTSP camera
unleash-stream-cli add 'rtsp://user:pass@192.168.1.100:554/stream' -D 'rtmp://stream.unleashlive.com/rtmp/W123?token=abc'

# RTMP source
unleash-stream-cli add 'rtmp://192.168.0.1:1935/main' -D 'rtmp://stream.unleashlive.com/rtmp/W456?token=def'

# HTTP stream (m3u8 playlist)
unleash-stream-cli add 'http://cams.remote.com/cdn/chunks.m3u8' -D 'rtmp://stream.unleashlive.com/rtmp/W789?token=ghi'

# Local video file
unleash-stream-cli add '/home/user/video/recording.mp4' -D 'rtmp://stream.unleashlive.com/rtmp/W321?token=jkl'

# With a display name and continuous mode
unleash-stream-cli add 'rtsp://cam/stream' -D 'rtmp://stream.unleashlive.com/rtmp/W654?token=mno' -n 'Main Entrance' -C

# Using device ID and token separately
unleash-stream-cli add 'rtsp://cam/stream' -d W123a4b5678c9de0 -t fluffy-black-dog-11

`add-snapshot`

Add periodic snapshot capture.

unleash-stream-cli add-snapshot SOURCE --device DEVICE_ID --api-key API_KEY [OPTIONS]

Captures a still image from the source at regular intervals and uploads it to Unleash live via API.

Options:

Option	Short	Description
`--device DEVICE_ID`	`-d`	Unleash live device ID (required)
`--api-key API_KEY`	`-a`	Unleash live API key (required)
`--interval SECS`	`-i`	Capture interval in seconds (default: `60`)
`--name NAME`	`-n`	Display name (defaults to device ID)
`--timeout SECS`		Connection timeout (default: `30`)

Examples:

# macOS local camera, every 60 seconds
unleash-stream-cli add-snapshot '0' -d W123abc -a YOUR_API_KEY -i 60

# Linux local camera
unleash-stream-cli add-snapshot '/dev/video0' -d W123abc -a YOUR_API_KEY -i 120

# RTSP camera
unleash-stream-cli add-snapshot 'rtsp://user:pass@192.168.1.100/stream' -d W123abc -a YOUR_API_KEY -i 30

`list`

List managed streams and snapshots.

unleash-stream-cli list [-v]

Shows all managed streams and snapshots with their status.

Output includes:

Stream name, source, destination, and current status

Visual indicators:

🎥 live stream source
📼 local file source
📷 snapshot capture
🔄 continuous mode (-C)

Status values:

running (green)
stopped (yellow)
failed (red)

Verbose output:

Use -v / --verbose for extended metadata in the CLI output (retry count, all log files, etc.).

`start`

Starts a previously stopped or failed stream. Resets the retry counter.

unleash-stream-cli start DEVICE_ID

unleash-stream-cli start --all

`stop`

Stops a running stream by sending SIGKILL to the FFmpeg process. The stream stays in the list and can be restarted with start.

unleash-stream-cli stop DEVICE_ID

unleash-stream-cli stop --all

unleash-stream-cli stop DEVICE_ID --snapshot   # Stop a snapshot capture

`remove`

Removes a stream from the managed list. Auto-stops if currently running. Also removes it from persistence so it is not restored after service restart.

unleash-stream-cli remove DEVICE_ID

unleash-stream-cli remove --all

unleash-stream-cli remove DEVICE_ID --snapshot

`logs`

Views stream logs.

Show logs for all streams

unleash-stream-cli logs

Filter by device ID or name

unleash-stream-cli logs DEVICE_OR_NAME

Follow log output in real-time

unleash-stream-cli logs -f

`local-devices`

Lists available video and audio capture devices (AVFoundation on macOS, v4l2 on Linux).

unleash-stream-cli local-devices

`service`

Manage or inspect the CLI service.

Start the background service

unleash-stream-cli service start

Show CLI and service version

unleash-stream-cli service version

The service is managed by the host OS service manager (launchd, systemd, or procd) and typically does not require manual start.