Video & Audio
OBS Studio CLI
Live streaming and screen recording control via obs-websocket
✓ 153 tests passed
Install
$ pip install cli-anything-obs-studio
About
Control OBS Studio programmatically via JSON scene files and obs-websocket protocol. Manage scenes, sources, recording state, stream configuration and transitions from the command line.
Requirements
OBS Studio with obs-websocket plugin
Command Reference
| Command | Arguments | Description |
|---|---|---|
detect |
Check OBS WebSocket connection | |
version |
Show OBS and websocket version | |
scene list |
List all scenes | |
scene switch |
SCENE_NAME |
Switch to scene |
record start |
Start recording | |
record stop |
Stop recording | |
stream start |
Start streaming | |
stream stop |
Stop streaming | |
source list |
--scene SCENE |
List sources in scene |
Usage Examples
# Install
$ pip install cli-anything-obs-studio
# Health check
$ obs-cli detect
# Get capabilities schema (Agent-ready, no token needed)
$ obs-cli schema
# Run with JSON output (for AI Agent integration)
$ obs-cli --json detect
# Example JSON response:
{"recording":true,"streaming":false,"current_scene":"Game Capture","fps":60}Agent Integration
# Python — call from AI Agent
import subprocess, json
result = subprocess.run(
["obs-cli", "--json", "detect"],
capture_output=True, text=True
)
data = json.loads(result.stdout)
print(data)
# Discover all commands without credentials:
schema = subprocess.run(
["obs-cli", "schema"],
capture_output=True, text=True
)
capabilities = json.loads(schema.stdout)