-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,41 @@ | ||
# obs-cli | ||
|
||
[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/muesli/obs-cli) | ||
[![Go ReportCard](http://goreportcard.com/badge/muesli/obs-cli)](http://goreportcard.com/report/muesli/obs-cli) | ||
|
||
OBS-cli is a command-line remote control for OBS | ||
|
||
## Installation | ||
|
||
Make sure you have a working Go environment (Go 1.11 or higher is required). | ||
See the [install instructions](http://golang.org/doc/install.html). | ||
|
||
To install obs-cli, simply run: | ||
|
||
go get github.com/muesli/obs-cli | ||
|
||
## Usage | ||
|
||
List special sources: | ||
|
||
```bash | ||
obs-cli list-sources | ||
``` | ||
|
||
Stop streaming: | ||
|
||
```bash | ||
obs-cli stop-stream | ||
``` | ||
|
||
Switch to a scene: | ||
|
||
```bash | ||
obs-cli switch-scene <scene> | ||
``` | ||
|
||
Toggle mute status of a source: | ||
|
||
```bash | ||
obs-cli toggle-mute <source> | ||
``` |