Skip to content

Commit

Permalink
CI badge and better usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
g committed Jul 17, 2023
1 parent b38f895 commit 955ed50
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

I was used to [obs-cli](https://github.com/muesli/obs-cli/pull/64) but it doesn't support `obs-websocket` 5

[![Latest Release](https://img.shields.io/github/release/grigio/obs-cmd.svg)](https://github.com/grigio/obs-cmd/releases)
[![release](https://github.com/grigio/obs-cmd/actions/workflows/release.yml/badge.svg)](https://github.com/grigio/obs-cmd/actions/workflows/release.yml)

### Usage

Expand All @@ -19,7 +19,26 @@ obs-cmd replay save
obs-cmd info
```

### Installation
### Installation

Download `obs-cmd`, pick the correct binary for your OS, example `obs-cmd-linux-amd64`

https://github.com/grigio/obs-cmd/releases/latest

type in the terminal:

```
chmod +x obs-cmd-linux-amd64 && sudo mv obs-cmd-linux-amd64 /usr/local/bin/obs-cmd
```

Or run this commands to build the binary from source and install it

```
cargo build --release
sudo ln -s $PWD/target/release/obs-cmd /usr/local/bin/
```

### Configuration

Create the config file in `~/.config/obs-cmd.toml`

Expand All @@ -30,9 +49,17 @@ OBS_WS_PASSWORD = "secret"

```

Run this commands to build the binary and install it
Open OBS Studio and set your `OBS_WS_PASSWORD` in `Tools > Websocker Server Settings`


### Usage

```
cargo build --release
sudo ln -s $PWD/target/release/obs-cmd /usr/local/bin/
➜ obs-cmd recording start
Recording started
Result: Ok(())
➜ obs-cmd recording stop
➜ obs-cmd info
Version: Version { obs_version: Version { major: 29, minor: 1, patch: 1 }, obs_web_socket_version: Version { major: 5, minor: 2, patch: 2 }, rpc_version: 1, available_requests: ..
```

0 comments on commit 955ed50

Please sign in to comment.