https://github.com/muesli/obs-cli
OBS-cli is a command-line remote control for OBS
https://github.com/muesli/obs-cli
hacktoberfest
Last synced: 2 months ago
JSON representation
OBS-cli is a command-line remote control for OBS
- Host: GitHub
- URL: https://github.com/muesli/obs-cli
- Owner: muesli
- License: mit
- Created: 2020-02-04T23:15:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T18:59:37.000Z (about 2 years ago)
- Last Synced: 2025-03-29T19:05:35.847Z (3 months ago)
- Topics: hacktoberfest
- Language: Go
- Size: 56.6 KB
- Stars: 413
- Watchers: 8
- Forks: 37
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# obs-cli
[](https://github.com/muesli/obs-cli/releases)
[](https://github.com/muesli/obs-cli/actions)
[](https://goreportcard.com/report/muesli/obs-cli)
[](https://pkg.go.dev/github.com/muesli/obs-cli)
OBS-cli is a command-line remote control for OBS. It requires the
[obs-websocket](https://github.com/Palakis/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](https://github.com/muesli/obs-cli/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.12 or higher is required). See the
[install instructions](https://golang.org/doc/install.html).
To install obs-cli, simply run:
go install github.com/muesli/obs-cli@latest
## Usage
All commands support the following flags:
- `--host`: which OBS instance to connect to
- `--port`: port to connect to
- `--password`: password used for authentication
### Streams
Change the streaming state:
```
obs-cli stream start
obs-cli stream stop
obs-cli stream toggle
```
Display streaming status:
```
obs-cli stream status
```
### Recordings
Change the recording state:
```
obs-cli recording start
obs-cli recording stop
obs-cli recording toggle
```
Pause or resume a recording:
```
obs-cli recording pause enable
obs-cli recording pause resume
obs-cli recording pause toggle
```
Display recording status:
```
obs-cli recording status
```
### Scenes
List all scene names:
```
obs-cli scene list
```
Show the current scene name:
```
obs-cli scene get
```
Switch program to a scene:
```
obs-cli scene current
```
Switch preview to a scene (studio mode must be enabled):
```
obs-cli scene preview
```
Switch program (studio mode disabled) or preview (studio mode enabled) to a scene:
```
obs-cli scene switch
```
### Scene Collections
List all scene collections:
```
obs-cli scenecollection list
```
Show the current scene collection:
```
obs-cli scenecollection get
```
Switch to a scene collection:
```
obs-cli scenecollection set
```
### Scene Items
List all items of a scene:
```
obs-cli sceneitem list
```
Change the visibility of a scene-item:
```
obs-cli sceneitem show
obs-cli sceneitem hide
obs-cli sceneitem toggle
```
Display the visibility of a scene-item:
```
obs-cli sceneitem visible
```
Center a scene-item horizontally:
```
obs-cli sceneitem center
```
### Labels
Change a FreeType text label:
```
obs-cli label text
```
Trigger a countdown and continuously update a label with the remaining time:
```
obs-cli label countdown
```
### Sources
List special sources:
```
obs-cli source list
```
Toggle mute status of a source:
```
obs-cli source toggle-mute
```
### Studio Mode
Enable or disable Studio Mode:
```
obs-cli studiomode enable
obs-cli studiomode disable
obs-cli studiomode toggle
```
Display studio mode status:
```
obs-cli studiomode status
```
Transition to program (when the studio mode is enabled):
```
obs-cli studiomode transition
```
### Profiles
List all profiles:
```
obs-cli profile list
```
Show the current profile:
```
obs-cli profile get
```
Switch to a profile:
```
obs-cli profile set
```
### Replay Buffer
Change the replay buffer state:
```
obs-cli replaybuffer start
obs-cli replaybuffer stop
```
Save the replay buffer:
```
obs-cli replaybuffer save
```
Display replay buffer status:
```
obs-cli replaybuffer status
```
### Virtual Camera
Change the virtual camera state:
```
obs-cli virtualcam start
obs-cli virtualcam stop
obs-cli virtualcam toggle
```
Display virtual camera status:
```
obs-cli virtualcam status
```