README.md

obs-cli

OBS-cli is a command-line remote control for OBS. It requires the obs-websocket plugin to be installed on your system.

Installation

Packages & Binaries

On Arch Linux you can simply install the package from the AUR:

yay -S obs-cli

Or download a binary from the releases page. Linux (including ARM) binaries are available, as well as Debian and RPM packages.

Build From Source

Alternatively you can also build obs-cli from source. Make sure you have a working Go environment (Go 1.11 or higher is required). See the install instructions.

To install obs-cli, simply run:

go get github.com/muesli/obs-cli

Usage

Start streaming:

obs-cli start-stream

Stop streaming:

obs-cli stop-stream

Switch to a scene:

obs-cli switch-scene <scene>

Change a FreeType text label:

obs-cli change-text <label> <text>

List all items of a scene:

obs-cli list-sceneitems <scene>

Make a scene-item visible:

obs-cli show-sceneitem <scene> <item>

Hide a scene-item:

obs-cli hide-sceneitem <scene> <item>

List special sources:

obs-cli list-sources

Toggle mute status of a source:

obs-cli toggle-mute <source>