Compare commits

...

32 Commits

Author SHA1 Message Date
8a5ce67ba0 add 0.15.0 to CHANGELOG 2026-01-08 15:36:12 +00:00
474693e0f7 add new input subcommands to README 2026-01-08 15:33:56 +00:00
a960c9ffa5 reorder commands
add input kind-defaults
2026-01-08 15:31:02 +00:00
8ce8727a0a rename input kinds to input list-kinds
rename input delete to input remove

add input volume
2026-01-08 14:14:40 +00:00
Noah Zoschke
fba7c4ce20 format 2025-07-30 07:02:27 -07:00
Noah Zoschke
c5e7bb4e1a delete 2025-07-29 16:35:10 -07:00
Noah Zoschke
e087fdefe3 update 2025-07-29 16:29:52 -07:00
Noah Zoschke
bd4a6cad4b show verbose 2025-07-29 16:18:56 -07:00
Noah Zoschke
72fc7d4092 kinds 2025-07-29 15:55:44 -07:00
Noah Zoschke
cb735cd666 show 2025-07-29 15:33:22 -07:00
Noah Zoschke
db70f8766d create input 2025-07-29 14:30:49 -07:00
c6406888a9 display (empty) if no text is set 2025-07-14 03:44:12 +01:00
f65af8298d add 0.14.0 to CHANGELOG 2025-07-14 03:34:18 +01:00
1dfb6f87ac add TextCmd to README 2025-07-14 03:33:58 +01:00
866aedde7c add text command group 2025-07-14 03:33:49 +01:00
9eb6c8a282 use red in example 2025-06-27 13:53:55 +01:00
eb30cae5b7 add 0.13.3 to CHANGELOG 2025-06-27 13:51:42 +01:00
e6c03a2c92 add style to ToC 2025-06-27 13:49:34 +01:00
f6b82383f9 add ToC to README
move style section.

add imgs
2025-06-27 13:48:17 +01:00
55f3b0c981 fix item id alignment 2025-06-27 13:38:51 +01:00
7da80a1ad2 fix patch number... 2025-06-26 12:15:36 +01:00
ea4ca2aeb9 fix patch number 2025-06-26 12:14:40 +01:00
d2f0a64180 changes to help:
- print help on error
- print in compact mode

move version + VersionFlag into main
store version in kong.Vars

add 0.13.3 to CHANGELOG
2025-06-26 12:13:32 +01:00
f01fd0ca84 check if output is paused before attempting record split/chapter.
add note to changelog about supported file format for record chapter.
2025-06-23 08:28:49 +01:00
10d50df445 add 0.13.0 to CHANGELOG 2025-06-23 08:03:52 +01:00
06cefe58ed add record split and record chapter commands 2025-06-23 08:02:31 +01:00
7cd1c78f6a add --no-border to 0.12.1 Added 2025-06-21 20:29:42 +01:00
842d98edd3 upd Style section in README
add example
2025-06-21 20:27:46 +01:00
930b387b85 newContext now requires a StyleConfig, update tests. 2025-06-21 20:27:17 +01:00
2ab1c5bfc3 if --no-border is set, disable the border styling 2025-06-21 20:25:48 +01:00
08f23fe47d add --no-border flag
use it to disable table border styling
2025-06-21 20:25:19 +01:00
bbc6aec230 add note about style env var in README
add 0.12.0 to CHANGELOG
2025-06-21 06:59:36 +01:00
22 changed files with 817 additions and 139 deletions

View File

@@ -5,6 +5,52 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
# [0.15.0] - 2026-01-26
### Added
- new subcommands added to input, see [InputCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#inputcmd)
# [0.14.1] - 2025-07-14
### Added
- text command group, see [TextCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#textcmd)
# [0.13.3] - 2025-06-27
### Changed
- usage is now printed on errors.
- help is printed in compact mode. This should make it easier to page through help on the root command.
### Fixed
- Item ID alignment in sceneitem list table.
# [0.13.0] - 2025-06-23
### Added
- record split and record chapter commands, see [RecordCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#recordcmd)
- As of OBS 30.2.0, the only file format supporting *record chapter* is Hybrid MP4.
# [0.12.1] - 2025-06-21
### Added
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/gobs-cli/tree/main?tab=readme-ov-file#style)
- colouring is applied to list tables as well as highlighted information in stdout/stderr output.
- table border styling may be optionally disabled with the --no-border flag.
### Changed
- if an itemName is passed to a sceneitem command that's in a group, without the --group flag, a friendlier error message is displayed.
- it will suggest using *gobs-cli si ls* to list sources in the scene.
- if an invalid --monitor-index is passed to projector open a friendlier error message is displayed.
- it will suggest using *gobs-cli prj ls-m* to list available monitors.
# [0.11.0] - 2025-06-20
### Added

138
README.md
View File

@@ -4,6 +4,16 @@ A command line interface for OBS Websocket v5
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
-----
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Style](#style)
- [Commands](#commands)
- [License](#license)
## Installation
```console
@@ -40,6 +50,36 @@ OBS_PASSWORD=<websocket password>
OBS_TIMEOUT=5
```
## Style
Styling is opt-in, by default you will get a colourless output:
![colourless](./img/colourless.png)
You may enable styling with the --style/-s flag:
```console
gobs-cli --style="red" sceneitem list
```
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
![coloured](./img/coloured-border.png)
Optionally you may disable border colouring with the --no-border flag:
![coloured-no-border](./img/coloured-no-border.png)
```console
gobs-cli --style="red" --no-border sceneitem list
```
Or with environment variables:
```env
GOBS_STYLE=red
GOBS_STYLE_NO_BORDER=true
```
## Commands
@@ -224,6 +264,20 @@ gobs-cli group status START "test_group"
### InputCmd
- create: Create input.
- args: Name Kind
```console
gobs-cli input create 'stream mix' 'wasapi_input_capture'
```
- remove: Remove input.
- args: Name
```console
gobs-cli input remove 'stream mix'
```
- list: List all inputs.
- flags:
@@ -241,6 +295,12 @@ gobs-cli input list
gobs-cli input list --input --colour
```
- list-kinds: List input kinds.
```console
gobs-cli input list-kinds
```
- mute: Mute input.
- args: InputName
@@ -262,6 +322,50 @@ gobs-cli input unmute "Mic/Aux"
gobs-cli input toggle "Mic/Aux"
```
- volume: Set input volume.
- args: InputName Volume
```console
gobs-cli input volume -- 'Mic/Aux' -30.6
```
- show: Show input details.
- args: Name
- flags:
*optional*
- --verbose: List all available input devices.
- update: Update input settings.
- args: InputName DeviceName
```console
gobs-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
```
- kind-defaults: Get default settings for an input kind.
- args: Kind
```console
gobs-cli input kind-defaults 'wasapi_input_capture'
```
### TextCmd
- current: Display current text for a text input.
- args: InputName
```console
gobs-cli text current "My Text Input"
```
- update: Update the text of a text input.
- args: InputName NewText
```console
gobs-cli text update "My Text Input" "hi OBS!"
```
### RecordCmd
- start: Start recording.
@@ -313,6 +417,21 @@ gobs-cli record directory "/home/me/obs-vids/"
gobs-cli record directory "C:/Users/me/Videos"
```
- split: Split recording.
```console
gobs-cli record split
```
- chapter: Create a chapter in the recording.
*optional*
- arg: ChapterName
```console
gobs-cli record chapter "Chapter Name"
```
### StreamCmd
- start: Start streaming.
@@ -606,24 +725,9 @@ gobs-cli projector open --monitor-index=1 "test_group"
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
```
## Style
## License
By default styling is disabled but you may enable it with the --style/-s flag.
Available options are:
- red
- magenta
- purple
- blue
- cyan
- green
- yellow
- orange
- white
- grey
- navy
- black
`gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir

View File

@@ -11,7 +11,7 @@ func TestFilterList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &FilterListCmd{
SourceName: "Mic/Aux",
@@ -30,7 +30,7 @@ func TestFilterListScene(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &FilterListCmd{
SourceName: "gobs-test",
@@ -49,7 +49,7 @@ func TestFilterListEmpty(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &FilterListCmd{
SourceName: "NonExistentSource",

View File

@@ -11,7 +11,7 @@ func TestGroupList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &GroupListCmd{
SceneName: "Scene",
@@ -30,7 +30,7 @@ func TestGroupShow(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &GroupShowCmd{
SceneName: "Scene",
@@ -50,7 +50,7 @@ func TestGroupToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &GroupStatusCmd{
SceneName: "Scene",
@@ -91,7 +91,7 @@ func TestGroupStatus(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdShow := &GroupShowCmd{
SceneName: "Scene",

BIN
img/coloured-border.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

BIN
img/coloured-no-border.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

BIN
img/colourless.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

373
input.go
View File

@@ -3,6 +3,7 @@ package main
import (
"fmt"
"maps"
"sort"
"strings"
@@ -13,10 +14,63 @@ import (
// InputCmd provides commands to manage inputs in OBS Studio.
type InputCmd struct {
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"`
Create InputCreateCmd `cmd:"" help:"Create input." aliases:"c"`
Remove InputRemoveCmd `cmd:"" help:"Remove input." aliases:"d"`
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
ListKinds InputListKindsCmd `cmd:"" help:"List input kinds." aliases:"k"`
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"`
Volume InputVolumeCmd `cmd:"" help:"Set input volume." aliases:"v"`
Show InputShowCmd `cmd:"" help:"Show input details." aliases:"s"`
Update InputUpdateCmd `cmd:"" help:"Update input settings." aliases:"up"`
KindDefaults InputKindDefaultsCmd `cmd:"" help:"Get default settings for an input kind." aliases:"df"`
}
// InputCreateCmd provides a command to create an input.
type InputCreateCmd struct {
Name string `arg:"" help:"Name for the input." required:""`
Kind string `arg:"" help:"Input kind (e.g., coreaudio_input_capture, macos-avcapture)." required:""`
}
// Run executes the command to create an input.
func (cmd *InputCreateCmd) Run(ctx *context) error {
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
if err != nil {
return err
}
_, err = ctx.Client.Inputs.CreateInput(
inputs.NewCreateInputParams().
WithInputKind(cmd.Kind).
WithInputName(cmd.Name).
WithSceneName(currentScene.CurrentProgramSceneName),
)
if err != nil {
return err
}
fmt.Fprintf(ctx.Out, "Created input: %s (%s) in scene %s\n",
ctx.Style.Highlight(cmd.Name), cmd.Kind, ctx.Style.Highlight(currentScene.CurrentProgramSceneName))
return nil
}
// InputRemoveCmd provides a command to remove an input.
type InputRemoveCmd struct {
Name string `arg:"" help:"Name of the input to remove." required:""`
}
// Run executes the command to remove an input.
func (cmd *InputRemoveCmd) Run(ctx *context) error {
_, err := ctx.Client.Inputs.RemoveInput(
inputs.NewRemoveInputParams().WithInputName(cmd.Name),
)
if err != nil {
return fmt.Errorf("failed to delete input: %w", err)
}
fmt.Fprintf(ctx.Out, "Deleted %s\n", ctx.Style.Highlight(cmd.Name))
return nil
}
// InputListCmd provides a command to list all inputs.
@@ -122,6 +176,47 @@ func (cmd *InputListCmd) Run(ctx *context) error {
return nil
}
// InputListKindsCmd provides a command to list all input kinds.
type InputListKindsCmd struct{}
// Run executes the command to list all input kinds.
func (cmd *InputListKindsCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputKindList(
inputs.NewGetInputKindListParams().WithUnversioned(false),
)
if err != nil {
return fmt.Errorf("failed to get input kinds: %w", err)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.Headers("Kind")
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
for _, kind := range resp.InputKinds {
t.Row(kind)
}
fmt.Fprintln(ctx.Out, t.Render())
return nil
}
// InputMuteCmd provides a command to mute an input.
type InputMuteCmd struct {
InputName string `arg:"" help:"Name of the input to mute."`
@@ -188,3 +283,273 @@ func (cmd *InputToggleCmd) Run(ctx *context) error {
}
return nil
}
// InputVolumeCmd provides a command to set the volume of an input.
type InputVolumeCmd struct {
InputName string `arg:"" help:"Name of the input to set volume for." required:""`
Volume float64 `arg:"" help:"Volume level (-90.0 to 0.0)." required:""`
}
// Run executes the command to set the volume of an input.
// accepts values between -90.0 and 0.0 representing decibels (dB).
func (cmd *InputVolumeCmd) Run(ctx *context) error {
if cmd.Volume < -90.0 || cmd.Volume > 0.0 {
return fmt.Errorf("volume must be between -90.0 and 0.0 dB")
}
_, err := ctx.Client.Inputs.SetInputVolume(
inputs.NewSetInputVolumeParams().
WithInputName(cmd.InputName).
WithInputVolumeDb(cmd.Volume),
)
if err != nil {
return fmt.Errorf("failed to set input volume: %w", err)
}
fmt.Fprintf(ctx.Out, "Set volume of input %s to %.1f dB\n",
ctx.Style.Highlight(cmd.InputName), cmd.Volume)
return nil
}
// InputShowCmd provides a command to show input details.
type InputShowCmd struct {
Name string `arg:"" help:"Name of the input to show." required:""`
Verbose bool ` help:"List all available input devices." flag:""`
}
// Run executes the command to show input details.
func (cmd *InputShowCmd) Run(ctx *context) error {
lresp, err := ctx.Client.Inputs.GetInputList(inputs.NewGetInputListParams())
if err != nil {
return fmt.Errorf("failed to get input list: %w", err)
}
var inputKind string
var found bool
for _, input := range lresp.Inputs {
if input.InputName == cmd.Name {
inputKind = input.InputKind
found = true
break
}
}
if !found {
return fmt.Errorf("input '%s' not found", cmd.Name)
}
prop, name := device(ctx, cmd.Name)
if prop == "" {
return fmt.Errorf("no device property found for input '%s'", cmd.Name)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.Headers("Input Name", "Kind", "Device")
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Left)
case 2:
style = style.Align(lipgloss.Center)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
t.Row(cmd.Name, snakeCaseToTitleCase(inputKind), name)
fmt.Fprintln(ctx.Out, t.Render())
if cmd.Verbose {
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
inputs.NewGetInputPropertiesListPropertyItemsParams().
WithInputName(cmd.Name).
WithPropertyName(prop),
)
if err != nil {
return fmt.Errorf("failed to get device list: %w", err)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
t.Headers("Devices")
for _, item := range deviceListResp.PropertyItems {
if item.ItemName != "" {
t.Row(item.ItemName)
}
}
fmt.Fprintln(ctx.Out, t.Render())
}
return nil
}
func device(ctx *context, inputName string) (string, string) {
settings, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(inputName),
)
if err != nil {
return "", ""
}
for _, propName := range []string{"device", "device_id"} {
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
inputs.NewGetInputPropertiesListPropertyItemsParams().
WithInputName(inputName).
WithPropertyName(propName),
)
if err == nil && len(deviceListResp.PropertyItems) > 0 {
for _, item := range deviceListResp.PropertyItems {
if item.ItemValue == settings.InputSettings[propName] {
return propName, item.ItemName
}
}
}
}
return "", ""
}
// InputUpdateCmd provides a command to update input settings.
type InputUpdateCmd struct {
InputName string `arg:"" help:"Name of the input to update." required:""`
DeviceName string `arg:"" help:"Name of the device to set." required:""`
}
// Run executes the command to update input settings.
func (cmd *InputUpdateCmd) Run(ctx *context) error {
// Use the device helper to find the correct device property name
prop, _ := device(ctx, cmd.InputName)
if prop == "" {
return fmt.Errorf("no device property found for input '%s'", cmd.InputName)
}
resp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
inputs.NewGetInputPropertiesListPropertyItemsParams().
WithInputName(cmd.InputName).
WithPropertyName(prop),
)
if err != nil {
return err
}
var deviceValue any
var found bool
for _, item := range resp.PropertyItems {
if item.ItemName == cmd.DeviceName {
deviceValue = item.ItemValue
found = true
break
}
}
if !found {
return fmt.Errorf("device '%s' not found for input '%s'", cmd.DeviceName, cmd.InputName)
}
sresp, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
)
if err != nil {
return err
}
settings := make(map[string]any)
maps.Copy(settings, sresp.InputSettings)
settings[prop] = deviceValue
_, err = ctx.Client.Inputs.SetInputSettings(
inputs.NewSetInputSettingsParams().
WithInputName(cmd.InputName).
WithInputSettings(settings),
)
if err != nil {
return fmt.Errorf("failed to update input settings: %w", err)
}
fmt.Fprintf(ctx.Out, "Input %s %s set to %s\n",
ctx.Style.Highlight(cmd.InputName), prop, ctx.Style.Highlight(cmd.DeviceName))
return nil
}
// InputKindDefaultsCmd provides a command to get default settings for an input kind.
type InputKindDefaultsCmd struct {
Kind string `arg:"" help:"Input kind to get default settings for." required:""`
}
// Run executes the command to get default settings for an input kind.
func (cmd *InputKindDefaultsCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputDefaultSettings(
inputs.NewGetInputDefaultSettingsParams().
WithInputKind(cmd.Kind),
)
if err != nil {
return fmt.Errorf("failed to get default settings for input kind '%s': %w", cmd.Kind, err)
}
t := table.New().Border(lipgloss.RoundedBorder()).
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
t.Headers("Setting", "Value")
t.StyleFunc(func(row, col int) lipgloss.Style {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
case 1:
style = style.Align(lipgloss.Center)
}
switch {
case row == table.HeaderRow:
style = style.Bold(true).Align(lipgloss.Center)
case row%2 == 0:
style = style.Foreground(ctx.Style.evenRows)
default:
style = style.Foreground(ctx.Style.oddRows)
}
return style
})
keys := make([]string, 0, len(resp.DefaultInputSettings))
for k := range resp.DefaultInputSettings {
keys = append(keys, k)
}
sort.Strings(keys)
for _, key := range keys {
value := resp.DefaultInputSettings[key]
t.Row(key, fmt.Sprintf("%v", value))
}
fmt.Fprintln(ctx.Out, t.Render())
return nil
}

View File

@@ -11,7 +11,7 @@ func TestInputList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &InputListCmd{}
err := cmd.Run(context)
@@ -39,7 +39,7 @@ func TestInputListFilterInput(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &InputListCmd{Input: true}
err := cmd.Run(context)
@@ -73,7 +73,7 @@ func TestInputListFilterOutput(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &InputListCmd{Output: true}
err := cmd.Run(context)
@@ -107,7 +107,7 @@ func TestInputListFilterColour(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &InputListCmd{Colour: true}
err := cmd.Run(context)

46
main.go
View File

@@ -8,6 +8,8 @@ import (
"io"
"os"
"path/filepath"
"runtime/debug"
"strings"
"time"
"github.com/alecthomas/kong"
@@ -16,6 +18,19 @@ import (
kongdotenv "github.com/titusjaka/kong-dotenv-go"
)
var version string // Version of the CLI, set at build time.
// VersionFlag is a custom flag type that prints the version and exits.
type VersionFlag string
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil } // nolint: revive
func (v VersionFlag) IsBool() bool { return true } // nolint: revive
func (v VersionFlag) BeforeApply(app *kong.Kong, vars kong.Vars) error { // nolint: revive, unparam
fmt.Printf("gobs-cli version: %s\n", vars["version"])
app.Exit(0)
return nil
}
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
type ObsConfig struct {
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
@@ -26,11 +41,12 @@ type ObsConfig struct {
// StyleConfig holds the configuration for styling the CLI output.
type StyleConfig struct {
Style string `help:"Style used in output." flag:"style" default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black"`
Style string `help:"Style used in output." flag:"style" default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black"`
NoBorder bool `help:"Disable table border styling in output." flag:"no-border" default:"false" env:"GOBS_STYLE_NO_BORDER" short:"b"`
}
// CLI is the main command line interface structure.
// It embeds the ObsConfig struct to inherit its fields and flags.
// It embeds ObsConfig and StyleConfig to provide configuration options.
type CLI struct {
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
StyleConfig `embed:"" help:"Style configuration."`
@@ -43,6 +59,7 @@ type CLI struct {
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"`
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"`
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i" group:"Input"`
Text TextCmd `help:"Manage text inputs." cmd:"" aliases:"t" group:"Text Input"`
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec" group:"Recording"`
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"`
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"`
@@ -62,11 +79,11 @@ type context struct {
Style *Style
}
func newContext(client *goobs.Client, out io.Writer, styleName string) *context {
func newContext(client *goobs.Client, out io.Writer, styleCfg StyleConfig) *context {
return &context{
Client: client,
Out: out,
Style: styleFromFlag(styleName),
Style: styleFromFlag(styleCfg),
}
}
@@ -80,15 +97,30 @@ func main() {
var cli CLI
ctx := kong.Parse(
&cli,
kong.Name("GOBS-CLI"),
kong.Name("gobs-cli"),
kong.Description("A command line tool to interact with OBS Websocket."),
kong.Configuration(kongdotenv.ENVFileReader, ".env", filepath.Join(userConfigDir, "gobs-cli", "config.env")),
)
kong.UsageOnError(),
kong.ConfigureHelp(kong.HelpOptions{
Compact: true,
}),
kong.Vars{
"version": func() string {
if version == "" {
info, ok := debug.ReadBuildInfo()
if !ok {
return "(unable to read build info)"
}
version = strings.Split(info.Main.Version, "-")[0]
}
return version
}(),
})
client, err := connectObs(cli.ObsConfig)
ctx.FatalIfErrorf(err)
ctx.Bind(newContext(client, os.Stdout, cli.StyleConfig.Style))
ctx.Bind(newContext(client, os.Stdout, cli.StyleConfig))
ctx.FatalIfErrorf(run(ctx, client))
}

View File

@@ -4,17 +4,20 @@ import (
"fmt"
"github.com/andreykaipov/goobs/api/requests/config"
"github.com/andreykaipov/goobs/api/requests/record"
)
// RecordCmd handles the recording commands.
type RecordCmd struct {
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"`
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"`
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"`
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"`
Split RecordSplitCmd `cmd:"" help:"Split recording." aliases:"sp"`
Chapter RecordChapterCmd `cmd:"" help:"Create a chapter in the recording." aliases:"c"`
}
// RecordStartCmd starts the recording.
@@ -187,3 +190,68 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory))
return nil
}
// RecordSplitCmd splits the current recording.
type RecordSplitCmd struct{} // size = 0x0
// Run executes the command to split the recording.
func (cmd *RecordSplitCmd) Run(ctx *context) error {
status, err := ctx.Client.Record.GetRecordStatus()
if err != nil {
return err
}
if !status.OutputActive {
return fmt.Errorf("recording is not in progress")
}
if status.OutputPaused {
return fmt.Errorf("recording is paused, cannot split")
}
_, err = ctx.Client.Record.SplitRecordFile()
if err != nil {
return err
}
fmt.Fprintln(ctx.Out, "Recording split successfully.")
return nil
}
// RecordChapterCmd creates a chapter in the recording.
type RecordChapterCmd struct {
ChapterName string `arg:"" help:"Name of the chapter to create." default:""`
}
// Run executes the command to create a chapter in the recording.
func (cmd *RecordChapterCmd) Run(ctx *context) error {
status, err := ctx.Client.Record.GetRecordStatus()
if err != nil {
return err
}
if !status.OutputActive {
return fmt.Errorf("recording is not in progress")
}
if status.OutputPaused {
return fmt.Errorf("recording is paused, cannot create chapter")
}
var params *record.CreateRecordChapterParams
if cmd.ChapterName == "" {
params = record.NewCreateRecordChapterParams()
} else {
params = record.NewCreateRecordChapterParams().WithChapterName(cmd.ChapterName)
}
_, err = ctx.Client.Record.CreateRecordChapter(params)
if err != nil {
return err
}
if cmd.ChapterName == "" {
cmd.ChapterName = "unnamed"
}
fmt.Fprintf(ctx.Out, "Chapter %s created successfully.\n", ctx.Style.Highlight(cmd.ChapterName))
return nil
}

View File

@@ -12,7 +12,7 @@ func TestRecordStart(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context)
@@ -52,7 +52,7 @@ func TestRecordStop(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context)
@@ -92,7 +92,7 @@ func TestRecordToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context)

View File

@@ -11,7 +11,7 @@ func TestReplayBufferStart(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &ReplayBufferStartCmd{}
err := cmd.Run(context)
@@ -28,7 +28,7 @@ func TestReplayBufferStop(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &ReplayBufferStopCmd{}
err := cmd.Run(context)
@@ -45,7 +45,7 @@ func TestReplayBufferToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &ReplayBufferStatusCmd{}
err := cmdStatus.Run(context)

View File

@@ -10,7 +10,7 @@ func TestSceneList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &SceneListCmd{}
err := cmd.Run(context)
@@ -27,7 +27,7 @@ func TestSceneCurrent(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
// Set the current scene to "gobs-test"
cmdSwitch := &SceneSwitchCmd{

View File

@@ -59,7 +59,7 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
style := lipgloss.NewStyle().Padding(0, 3)
switch col {
case 0:
style = style.Align(lipgloss.Left)
style = style.Align(lipgloss.Center)
case 1:
style = style.Align(lipgloss.Left)
case 2:

View File

@@ -11,7 +11,7 @@ func TestSceneItemList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &SceneItemListCmd{
SceneName: "gobs-test",

View File

@@ -12,7 +12,7 @@ func TestStreamStart(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context)
@@ -51,7 +51,7 @@ func TestStreamStop(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context)
@@ -90,7 +90,7 @@ func TestStreamToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context)

View File

@@ -10,7 +10,7 @@ func TestStudioModeEnable(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdEnable := &StudioModeEnableCmd{}
err := cmdEnable.Run(context)
@@ -38,7 +38,7 @@ func TestStudioModeDisable(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmdDisable := &StudioModeDisableCmd{}
err := cmdDisable.Run(context)

102
style.go
View File

@@ -26,88 +26,88 @@ func (s *Style) Error(text string) string {
return lipgloss.NewStyle().Foreground(lipgloss.Color("#FF0000")).Render(text) // Red for errors
}
func newRedStyle() *Style {
return &Style{
func newRedStyle() Style {
return Style{
name: "red",
border: lipgloss.Color("#D32F2F"), // Strong red for border
oddRows: lipgloss.Color("#FFCDD2"), // Very light red for odd rows
evenRows: lipgloss.Color("#EF9A9A"), // Light red for even rows
highlight: lipgloss.Color("#EF9A9A"),
highlight: lipgloss.Color("#EF9A9A"), // Highlight in light red
}
}
func newMagentaStyle() *Style {
return &Style{
func newMagentaStyle() Style {
return Style{
name: "magenta",
border: lipgloss.Color("#C2185B"), // Strong magenta for border
oddRows: lipgloss.Color("#F8BBD0"), // Very light magenta/pink for odd rows
evenRows: lipgloss.Color("#F48FB1"), // Light magenta/pink for even rows
highlight: lipgloss.Color("#F48FB1"),
highlight: lipgloss.Color("#F48FB1"), // Highlight in light magenta/pink
}
}
func newPurpleStyle() *Style {
return &Style{
func newPurpleStyle() Style {
return Style{
name: "purple",
border: lipgloss.Color("#7B1FA2"), // Strong purple for border
oddRows: lipgloss.Color("#E1BEE7"), // Very light purple for odd rows
evenRows: lipgloss.Color("#CE93D8"), // Light purple for even rows
highlight: lipgloss.Color("#CE93D8"),
highlight: lipgloss.Color("#CE93D8"), // Highlight in light purple
}
}
func newBlueStyle() *Style {
return &Style{
func newBlueStyle() Style {
return Style{
name: "blue",
border: lipgloss.Color("#1976D2"), // Medium blue for border
oddRows: lipgloss.Color("#E3F2FD"), // Very light blue for odd rows
evenRows: lipgloss.Color("#BBDEFB"), // Light blue for even rows
highlight: lipgloss.Color("#1976D2"),
highlight: lipgloss.Color("#1976D2"), // Highlight in medium blue
}
}
func newCyanStyle() *Style {
return &Style{
func newCyanStyle() Style {
return Style{
name: "cyan",
border: lipgloss.Color("#00BFCF"), // A strong cyan for border
oddRows: lipgloss.Color("#E0F7FA"), // Very light cyan for odd rows
evenRows: lipgloss.Color("#B2EBF2"), // Slightly darker light cyan for even rows
highlight: lipgloss.Color("#00BFCF"),
highlight: lipgloss.Color("#00BFCF"), // Highlight in strong cyan
}
}
func newGreenStyle() *Style {
return &Style{
func newGreenStyle() Style {
return Style{
name: "green",
border: lipgloss.Color("#43A047"), // Medium green for border
oddRows: lipgloss.Color("#E8F5E9"), // Very light green for odd rows
evenRows: lipgloss.Color("#C8E6C9"), // Light green for even rows
highlight: lipgloss.Color("#43A047"),
highlight: lipgloss.Color("#43A047"), // Highlight in medium green
}
}
func newYellowStyle() *Style {
return &Style{
func newYellowStyle() Style {
return Style{
name: "yellow",
border: lipgloss.Color("#FBC02D"), // Strong yellow for border
oddRows: lipgloss.Color("#FFF9C4"), // Very light yellow for odd rows
evenRows: lipgloss.Color("#FFF59D"), // Light yellow for even rows
highlight: lipgloss.Color("#FBC02D"),
highlight: lipgloss.Color("#FBC02D"), // Highlight in strong yellow
}
}
func newOrangeStyle() *Style {
return &Style{
func newOrangeStyle() Style {
return Style{
name: "orange",
border: lipgloss.Color("#F57C00"), // Strong orange for border
oddRows: lipgloss.Color("#FFF3E0"), // Very light orange for odd rows
evenRows: lipgloss.Color("#FFE0B2"), // Light orange for even rows
highlight: lipgloss.Color("#F57C00"),
highlight: lipgloss.Color("#F57C00"), // Highlight in strong orange
}
}
func newWhiteStyle() *Style {
return &Style{
func newWhiteStyle() Style {
return Style{
name: "white",
border: lipgloss.Color("#FFFFFF"), // White for border
oddRows: lipgloss.Color("#F0F0F0"), // Very light grey for odd rows
@@ -116,8 +116,8 @@ func newWhiteStyle() *Style {
}
}
func newGreyStyle() *Style {
return &Style{
func newGreyStyle() Style {
return Style{
name: "grey",
border: lipgloss.Color("#9E9E9E"), // Medium grey for border
oddRows: lipgloss.Color("#F5F5F5"), // Very light grey for odd rows
@@ -126,8 +126,8 @@ func newGreyStyle() *Style {
}
}
func newNavyBlueStyle() *Style {
return &Style{
func newNavyBlueStyle() Style {
return Style{
name: "navy",
border: lipgloss.Color("#001F3F"), // Navy blue for border
oddRows: lipgloss.Color("#CFE2F3"), // Very light blue for odd rows
@@ -136,8 +136,8 @@ func newNavyBlueStyle() *Style {
}
}
func newBlackStyle() *Style {
return &Style{
func newBlackStyle() Style {
return Style{
name: "black",
border: lipgloss.Color("#000000"), // Black for border
oddRows: lipgloss.Color("#333333"), // Dark grey for odd rows
@@ -146,32 +146,34 @@ func newBlackStyle() *Style {
}
}
func styleFromFlag(colour string) *Style {
switch colour {
func styleFromFlag(cfg StyleConfig) *Style {
var style Style
switch cfg.Style {
case "red":
return newRedStyle()
style = newRedStyle()
case "magenta":
return newMagentaStyle()
style = newMagentaStyle()
case "purple":
return newPurpleStyle()
style = newPurpleStyle()
case "blue":
return newBlueStyle()
style = newBlueStyle()
case "cyan":
return newCyanStyle()
style = newCyanStyle()
case "green":
return newGreenStyle()
style = newGreenStyle()
case "yellow":
return newYellowStyle()
style = newYellowStyle()
case "orange":
return newOrangeStyle()
style = newOrangeStyle()
case "white":
return newWhiteStyle()
style = newWhiteStyle()
case "grey":
return newGreyStyle()
style = newGreyStyle()
case "navy":
return newNavyBlueStyle()
style = newNavyBlueStyle()
case "black":
return newBlackStyle()
style = newBlackStyle()
default:
err := os.Setenv("NO_COLOR", "1") // nolint: misspell
if err != nil {
@@ -179,6 +181,12 @@ func styleFromFlag(colour string) *Style {
// This is a fallback to ensure that the application can still run
fmt.Fprintf(os.Stderr, "Error setting NO_COLOR: %v\n", err)
}
return &Style{}
}
// If noBorder is true, we disable the border styling
if cfg.NoBorder {
style.border = ""
}
return &style
}

85
text.go Normal file
View File

@@ -0,0 +1,85 @@
package main
import (
"fmt"
"strings"
"github.com/andreykaipov/goobs/api/requests/inputs"
)
// TextCmd provides commands for managing text inputs in OBS.
type TextCmd struct {
Current TextCurrentCmd `cmd:"current" help:"Display current text for a text input." aliases:"c"`
Update TextUpdateCmd `cmd:"update" help:"Update the text of a text input." aliases:"u"`
}
// TextCurrentCmd provides a command to display the current text of a text input.
type TextCurrentCmd struct {
InputName string `arg:"" help:"Name of the text source."`
}
// Run executes the command to display the current text of a text input.
func (cmd *TextCurrentCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
)
if err != nil {
return fmt.Errorf("failed to get input settings: %w", err)
}
// Check if the input is a text input
kind := resp.InputKind
if !strings.HasPrefix(kind, "text_") {
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
}
currentText, ok := resp.InputSettings["text"]
if !ok {
return fmt.Errorf("input %s does not have a 'text' setting", cmd.InputName)
}
if currentText == "" {
currentText = "(empty)"
}
fmt.Fprintf(
ctx.Out,
"Current text for source %s: %s\n",
ctx.Style.Highlight(cmd.InputName),
currentText,
)
return nil
}
// TextUpdateCmd provides a command to update the text of a text input.
type TextUpdateCmd struct {
InputName string `arg:"" help:"Name of the text source."`
NewText string `arg:"" help:"New text to set for the source." default:""`
}
// Run executes the command to update the text of a text input.
func (cmd *TextUpdateCmd) Run(ctx *context) error {
resp, err := ctx.Client.Inputs.GetInputSettings(
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
)
if err != nil {
return fmt.Errorf("failed to get input settings: %w", err)
}
// Check if the input is a text input
kind := resp.InputKind
if !strings.HasPrefix(kind, "text_") {
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
}
if _, err := ctx.Client.Inputs.SetInputSettings(&inputs.SetInputSettingsParams{
InputName: &cmd.InputName,
InputSettings: map[string]any{"text": &cmd.NewText},
}); err != nil {
return fmt.Errorf("failed to update text for source %s: %w", cmd.InputName, err)
}
if cmd.NewText == "" {
cmd.NewText = "(empty)"
}
fmt.Fprintf(ctx.Out, "Updated text for source %s to: %s\n", ctx.Style.Highlight(cmd.InputName), cmd.NewText)
return nil
}

View File

@@ -2,38 +2,8 @@ package main
import (
"fmt"
"runtime/debug"
"strings"
"github.com/alecthomas/kong"
)
var version string
// VersionFlag is a custom flag type for displaying version information.
type VersionFlag string
// Decode implements the kong.Flag interface.
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
// IsBool implements the kong.Flag interface.
func (v VersionFlag) IsBool() bool { return true }
// BeforeApply implements the kong.Flag interface.
func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error { // nolint: unparam
if version == "" {
info, ok := debug.ReadBuildInfo()
if !ok {
return fmt.Errorf("failed to read build info")
}
version = strings.Split(info.Main.Version, "-")[0]
}
fmt.Printf("gobs-cli version: %s\n", version)
app.Exit(0) // Exit the application after printing the version
return nil
}
// ObsVersionCmd handles the version command.
type ObsVersionCmd struct{} // size = 0x0

View File

@@ -11,7 +11,7 @@ func TestVersion(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, "")
context := newContext(client, &out, StyleConfig{})
cmd := &ObsVersionCmd{}
err := cmd.Run(context)