Compare commits

..

No commits in common. "main" and "v0.12.1" have entirely different histories.

20 changed files with 103 additions and 408 deletions

View File

@ -5,30 +5,6 @@ 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/), 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). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
# [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 # [0.12.1] - 2025-06-21
### Added ### Added

View File

@ -4,16 +4,6 @@ A command line interface for OBS Websocket v5
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) 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 ## Installation
```console ```console
@ -50,36 +40,6 @@ OBS_PASSWORD=<websocket password>
OBS_TIMEOUT=5 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 ## Commands
@ -302,22 +262,6 @@ gobs-cli input unmute "Mic/Aux"
gobs-cli input toggle "Mic/Aux" gobs-cli input toggle "Mic/Aux"
``` ```
### 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 ### RecordCmd
- start: Start recording. - start: Start recording.
@ -369,21 +313,6 @@ gobs-cli record directory "/home/me/obs-vids/"
gobs-cli record directory "C:/Users/me/Videos" 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 ### StreamCmd
- start: Start streaming. - start: Start streaming.
@ -677,9 +606,33 @@ gobs-cli projector open --monitor-index=1 "test_group"
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png" gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
``` ```
## License ## Style
`gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. By default styling is disabled but you may enable and configure it in the following ways:
- --style/-s: Style used in output.
- GOBS_STYLE
- --no-border/-b: Disable table border styling in output.
- GOBS_STYLE_NO_BORDER
Available styles:
- red
- magenta
- purple
- blue
- cyan
- green
- yellow
- orange
- white
- grey
- navy
- black
```console
gobs-cli --style=cyan --no-border scene list
```
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir [userconfigdir]: https://pkg.go.dev/os#UserConfigDir

View File

@ -22,7 +22,6 @@ tasks:
cmds: cmds:
- task: build-windows - task: build-windows
- task: build-linux - task: build-linux
- task: build-macos
vet: vet:
desc: Vet the code desc: Vet the code
@ -47,12 +46,6 @@ tasks:
- GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64 - GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
internal: true internal: true
build-macos:
desc: Build the gobs-cli project for macOS
cmds:
- GOOS=darwin GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_darwin_amd64
internal: true
test: test:
desc: Run tests desc: Run tests
cmds: cmds:

View File

@ -33,7 +33,7 @@ func TestFilterListScene(t *testing.T) {
context := newContext(client, &out, StyleConfig{}) context := newContext(client, &out, StyleConfig{})
cmd := &FilterListCmd{ cmd := &FilterListCmd{
SourceName: "gobs-test-scene", SourceName: "gobs-test",
} }
err := cmd.Run(context) err := cmd.Run(context)
if err != nil { if err != nil {

View File

@ -2,20 +2,11 @@ package main
import ( import (
"bytes" "bytes"
"os"
"strings" "strings"
"testing" "testing"
) )
func skipIfSkipGroupTests(t *testing.T) {
if os.Getenv("GOBS_TEST_SKIP_GROUP_TESTS") != "" {
t.Skip("Skipping group tests due to GOBS_TEST_SKIP_GROUP_TESTS environment variable")
}
}
func TestGroupList(t *testing.T) { func TestGroupList(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
@ -35,8 +26,6 @@ func TestGroupList(t *testing.T) {
} }
func TestGroupShow(t *testing.T) { func TestGroupShow(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
@ -57,8 +46,6 @@ func TestGroupShow(t *testing.T) {
} }
func TestGroupToggle(t *testing.T) { func TestGroupToggle(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
@ -100,8 +87,6 @@ func TestGroupToggle(t *testing.T) {
} }
func TestGroupStatus(t *testing.T) { func TestGroupStatus(t *testing.T) {
skipIfSkipGroupTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.6 KiB

View File

@ -22,8 +22,9 @@ func TestInputList(t *testing.T) {
expectedInputs := []string{ expectedInputs := []string{
"Desktop Audio", "Desktop Audio",
"Mic/Aux", "Mic/Aux",
"gobs-test-input", "Colour Source",
"gobs-test-input-2", "Colour Source 2",
"Colour Source 3",
} }
output := out.String() output := out.String()
for _, input := range expectedInputs { for _, input := range expectedInputs {
@ -51,8 +52,9 @@ func TestInputListFilterInput(t *testing.T) {
} }
expectedFilteredOut := []string{ expectedFilteredOut := []string{
"Desktop Audio", "Desktop Audio",
"gobs-test-input", "Colour Source",
"gobs-test-input-2", "Colour Source 2",
"Colour Source 3",
} }
for _, input := range expectedInputs { for _, input := range expectedInputs {
if !strings.Contains(out.String(), input) { if !strings.Contains(out.String(), input) {
@ -84,8 +86,9 @@ func TestInputListFilterOutput(t *testing.T) {
} }
expectedFilteredOut := []string{ expectedFilteredOut := []string{
"Mic/Aux", "Mic/Aux",
"gobs-test-input", "Colour Source",
"gobs-test-input-2", "Colour Source 2",
"Colour Source 3",
} }
for _, input := range expectedInputs { for _, input := range expectedInputs {
if !strings.Contains(out.String(), input) { if !strings.Contains(out.String(), input) {
@ -113,8 +116,9 @@ func TestInputListFilterColour(t *testing.T) {
} }
expectedInputs := []string{ expectedInputs := []string{
"gobs-test-input", "Colour Source",
"gobs-test-input-2", "Colour Source 2",
"Colour Source 3",
} }
for _, input := range expectedInputs { for _, input := range expectedInputs {
if !strings.Contains(out.String(), input) { if !strings.Contains(out.String(), input) {

37
main.go
View File

@ -8,8 +8,6 @@ import (
"io" "io"
"os" "os"
"path/filepath" "path/filepath"
"runtime/debug"
"strings"
"time" "time"
"github.com/alecthomas/kong" "github.com/alecthomas/kong"
@ -18,19 +16,6 @@ import (
kongdotenv "github.com/titusjaka/kong-dotenv-go" 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. // ObsConfig holds the configuration for connecting to the OBS WebSocket server.
type ObsConfig struct { type ObsConfig struct {
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"` Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
@ -46,7 +31,7 @@ type StyleConfig struct {
} }
// CLI is the main command line interface structure. // CLI is the main command line interface structure.
// It embeds ObsConfig and StyleConfig to provide configuration options. // It embeds the ObsConfig struct to inherit its fields and flags.
type CLI struct { type CLI struct {
ObsConfig `embed:"" help:"OBS WebSocket configuration."` ObsConfig `embed:"" help:"OBS WebSocket configuration."`
StyleConfig `embed:"" help:"Style configuration."` StyleConfig `embed:"" help:"Style configuration."`
@ -59,7 +44,6 @@ type CLI struct {
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"` Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"`
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"` Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"`
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i" group:"Input"` 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"` Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec" group:"Recording"`
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"` Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"`
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"` Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"`
@ -97,25 +81,10 @@ func main() {
var cli CLI var cli CLI
ctx := kong.Parse( ctx := kong.Parse(
&cli, &cli,
kong.Name("gobs-cli"), kong.Name("GOBS-CLI"),
kong.Description("A command line tool to interact with OBS Websocket."), kong.Description("A command line tool to interact with OBS Websocket."),
kong.Configuration(kongdotenv.ENVFileReader, ".env", filepath.Join(userConfigDir, "gobs-cli", "config.env")), 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) client, err := connectObs(cli.ObsConfig)
ctx.FatalIfErrorf(err) ctx.FatalIfErrorf(err)

View File

@ -2,9 +2,7 @@ package main
import ( import (
"os" "os"
"runtime"
"testing" "testing"
"time"
"github.com/andreykaipov/goobs" "github.com/andreykaipov/goobs"
"github.com/andreykaipov/goobs/api/requests/config" "github.com/andreykaipov/goobs/api/requests/config"
@ -64,23 +62,13 @@ func setup(client *goobs.Client) {
Key: os.Getenv("OBS_STREAM_KEY"), Key: os.Getenv("OBS_STREAM_KEY"),
})) }))
client.Config.CreateProfile(config.NewCreateProfileParams(). client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
WithProfileName("gobs-test-profile")) WithSceneCollectionName("test-collection"))
time.Sleep(100 * time.Millisecond) // Wait for the profile to be created
client.Config.SetProfileParameter(config.NewSetProfileParameterParams().
WithParameterCategory("SimpleOutput").
WithParameterName("RecRB").
WithParameterValue("true"))
// hack to ensure the Replay Buffer setting is applied
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
WithProfileName("Untitled"))
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
WithProfileName("gobs-test-profile"))
client.Scenes.CreateScene(scenes.NewCreateSceneParams(). client.Scenes.CreateScene(scenes.NewCreateSceneParams().
WithSceneName("gobs-test-scene")) WithSceneName("gobs-test"))
client.Inputs.CreateInput(inputs.NewCreateInputParams(). client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test-scene"). WithSceneName("gobs-test").
WithInputName("gobs-test-input"). WithInputName("gobs-test-input").
WithInputKind("color_source_v3"). WithInputKind("color_source_v3").
WithInputSettings(map[string]any{ WithInputSettings(map[string]any{
@ -91,7 +79,7 @@ func setup(client *goobs.Client) {
}). }).
WithSceneItemEnabled(true)) WithSceneItemEnabled(true))
client.Inputs.CreateInput(inputs.NewCreateInputParams(). client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test-scene"). WithSceneName("gobs-test").
WithInputName("gobs-test-input-2"). WithInputName("gobs-test-input-2").
WithInputKind("color_source_v3"). WithInputKind("color_source_v3").
WithInputSettings(map[string]any{ WithInputSettings(map[string]any{
@ -102,37 +90,6 @@ func setup(client *goobs.Client) {
}). }).
WithSceneItemEnabled(true)) WithSceneItemEnabled(true))
// ensure Desktop Audio input is created
desktopAudioKinds := map[string]string{
"windows": "wasapi_output_capture",
"linux": "pulse_output_capture",
"darwin": "coreaudio_output_capture",
}
platform := os.Getenv("GOBS_TEST_PLATFORM")
if platform == "" {
platform = runtime.GOOS
}
client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test-scene").
WithInputName("Desktop Audio").
WithInputKind(desktopAudioKinds[platform]).
WithInputSettings(map[string]any{
"device_id": "default",
}))
// ensure Mic/Aux input is created
micKinds := map[string]string{
"windows": "wasapi_input_capture",
"linux": "pulse_input_capture",
"darwin": "coreaudio_input_capture",
}
client.Inputs.CreateInput(inputs.NewCreateInputParams().
WithSceneName("gobs-test-scene").
WithInputName("Mic/Aux").
WithInputKind(micKinds[platform]).
WithInputSettings(map[string]any{
"device_id": "default",
}))
// Create source filter on an audio input // Create source filter on an audio input
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams(). client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
WithSourceName("Mic/Aux"). WithSourceName("Mic/Aux").
@ -149,7 +106,7 @@ func setup(client *goobs.Client) {
// Create source filter on a scene // Create source filter on a scene
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams(). client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
WithSourceName("gobs-test-scene"). WithSourceName("gobs-test").
WithFilterName("test_filter"). WithFilterName("test_filter").
WithFilterKind("luma_key_filter_v2"). WithFilterKind("luma_key_filter_v2").
WithFilterSettings(map[string]any{ WithFilterSettings(map[string]any{
@ -158,21 +115,18 @@ func setup(client *goobs.Client) {
} }
func teardown(client *goobs.Client) { func teardown(client *goobs.Client) {
client.Config.RemoveProfile(config.NewRemoveProfileParams().
WithProfileName("gobs-test-profile"))
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams(). client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
WithSourceName("Mic/Aux"). WithSourceName("Mic/Aux").
WithFilterName("test_filter")) WithFilterName("test_filter"))
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams(). client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
WithSourceName("gobs-test-scene"). WithSourceName("gobs-test").
WithFilterName("test_filter")) WithFilterName("test_filter"))
client.Scenes.RemoveScene(scenes.NewRemoveSceneParams(). client.Scenes.RemoveScene(scenes.NewRemoveSceneParams().
WithSceneName("gobs-test-scene")) WithSceneName("gobs-test"))
client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams(). client.Config.SetCurrentSceneCollection(config.NewSetCurrentSceneCollectionParams().
WithSceneCollectionName("Untitled")) WithSceneCollectionName("default"))
client.Stream.StopStream() client.Stream.StopStream()
client.Record.StopRecord() client.Record.StopRecord()

View File

@ -4,7 +4,6 @@ import (
"fmt" "fmt"
"github.com/andreykaipov/goobs/api/requests/config" "github.com/andreykaipov/goobs/api/requests/config"
"github.com/andreykaipov/goobs/api/requests/record"
) )
// RecordCmd handles the recording commands. // RecordCmd handles the recording commands.
@ -16,8 +15,6 @@ type RecordCmd struct {
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"` Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"` Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"` 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. // RecordStartCmd starts the recording.
@ -190,68 +187,3 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory)) fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory))
return nil 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

@ -44,7 +44,7 @@ func TestRecordStart(t *testing.T) {
if out.String() != "Recording started successfully.\n" { if out.String() != "Recording started successfully.\n" {
t.Fatalf("Expected output to contain 'Recording started successfully.', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Recording started successfully.', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the recording to start time.Sleep(1 * time.Second) // Wait for the recording to start
} }
func TestRecordStop(t *testing.T) { func TestRecordStop(t *testing.T) {
@ -84,7 +84,7 @@ func TestRecordStop(t *testing.T) {
if !strings.Contains(out.String(), "Recording stopped successfully. Output file: ") { if !strings.Contains(out.String(), "Recording stopped successfully. Output file: ") {
t.Fatalf("Expected output to contain 'Recording stopped successfully. Output file: ', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Recording stopped successfully. Output file: ', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the recording to stop time.Sleep(1 * time.Second) // Wait for the recording to stop
} }
func TestRecordToggle(t *testing.T) { func TestRecordToggle(t *testing.T) {
@ -112,6 +112,8 @@ func TestRecordToggle(t *testing.T) {
t.Fatalf("Failed to toggle recording: %v", err) t.Fatalf("Failed to toggle recording: %v", err)
} }
time.Sleep(1 * time.Second) // Wait for a second to ensure toggle has taken effect
if active { if active {
if out.String() != "Recording stopped successfully.\n" { if out.String() != "Recording stopped successfully.\n" {
t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Recording stopped successfully.', got '%s'", out.String())
@ -121,5 +123,4 @@ func TestRecordToggle(t *testing.T) {
t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Recording started successfully.', got '%s'", out.String())
} }
} }
time.Sleep(500 * time.Millisecond) // Wait for the toggle to take effect
} }

View File

@ -2,21 +2,11 @@ package main
import ( import (
"bytes" "bytes"
"os"
"strings" "strings"
"testing" "testing"
"time"
) )
func skipIfSkipReplayBufferTests(t *testing.T) {
if os.Getenv("GOBS_TEST_SKIP_REPLAYBUFFER_TESTS") != "" {
t.Skip("Skipping replay buffer tests due to GOBS_TEST_SKIP_REPLAYBUFFER_TESTS environment variable")
}
}
func TestReplayBufferStart(t *testing.T) { func TestReplayBufferStart(t *testing.T) {
skipIfSkipReplayBufferTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
@ -31,12 +21,9 @@ func TestReplayBufferStart(t *testing.T) {
if out.String() != "Replay buffer started.\n" { if out.String() != "Replay buffer started.\n" {
t.Fatalf("Expected output to be 'Replay buffer started', got '%s'", out.String()) t.Fatalf("Expected output to be 'Replay buffer started', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the replay buffer to start
} }
func TestReplayBufferStop(t *testing.T) { func TestReplayBufferStop(t *testing.T) {
skipIfSkipReplayBufferTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
@ -51,12 +38,9 @@ func TestReplayBufferStop(t *testing.T) {
if out.String() != "Replay buffer stopped.\n" { if out.String() != "Replay buffer stopped.\n" {
t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Replay buffer stopped.', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the replay buffer to stop
} }
func TestReplayBufferToggle(t *testing.T) { func TestReplayBufferToggle(t *testing.T) {
skipIfSkipReplayBufferTests(t)
client, disconnect := getClient(t) client, disconnect := getClient(t)
defer disconnect() defer disconnect()
@ -89,5 +73,4 @@ func TestReplayBufferToggle(t *testing.T) {
t.Fatalf("Expected output to be 'Replay buffer started.', got '%s'", out.String()) t.Fatalf("Expected output to be 'Replay buffer started.', got '%s'", out.String())
} }
} }
time.Sleep(500 * time.Millisecond) // Wait for the toggle to take effect
} }

View File

@ -17,8 +17,8 @@ func TestSceneList(t *testing.T) {
if err != nil { if err != nil {
t.Fatalf("Failed to list scenes: %v", err) t.Fatalf("Failed to list scenes: %v", err)
} }
if out.String() == "Current program scene: gobs-test-scene\n" { if out.String() == "Current program scene: gobs-test\n" {
t.Fatalf("Expected output to be 'Current program scene: gobs-test-scene', got '%s'", out.String()) t.Fatalf("Expected output to be 'Current program scene: gobs-test', got '%s'", out.String())
} }
} }
@ -29,9 +29,9 @@ func TestSceneCurrent(t *testing.T) {
var out bytes.Buffer var out bytes.Buffer
context := newContext(client, &out, StyleConfig{}) context := newContext(client, &out, StyleConfig{})
// Set the current scene to "gobs-test-scene" // Set the current scene to "gobs-test"
cmdSwitch := &SceneSwitchCmd{ cmdSwitch := &SceneSwitchCmd{
NewScene: "gobs-test-scene", NewScene: "gobs-test",
} }
err := cmdSwitch.Run(context) err := cmdSwitch.Run(context)
if err != nil { if err != nil {
@ -45,7 +45,7 @@ func TestSceneCurrent(t *testing.T) {
if err != nil { if err != nil {
t.Fatalf("Failed to get current scene: %v", err) t.Fatalf("Failed to get current scene: %v", err)
} }
if out.String() != "Current program scene: gobs-test-scene\n" { if out.String() != "Current program scene: gobs-test\n" {
t.Fatalf("Expected output to be 'Current program scene: gobs-test-scene', got '%s'", out.String()) t.Fatalf("Expected output to be 'Current program scene: gobs-test', got '%s'", out.String())
} }
} }

View File

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

View File

@ -14,7 +14,7 @@ func TestSceneItemList(t *testing.T) {
context := newContext(client, &out, StyleConfig{}) context := newContext(client, &out, StyleConfig{})
cmd := &SceneItemListCmd{ cmd := &SceneItemListCmd{
SceneName: "gobs-test-scene", SceneName: "gobs-test",
} }
err := cmd.Run(context) err := cmd.Run(context)
if err != nil { if err != nil {

View File

@ -43,7 +43,7 @@ func TestStreamStart(t *testing.T) {
if out.String() != "Stream started successfully.\n" { if out.String() != "Stream started successfully.\n" {
t.Fatalf("Expected output to contain 'Stream started successfully.', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Stream started successfully.', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the stream to start time.Sleep(2 * time.Second) // Wait for the stream to start
} }
func TestStreamStop(t *testing.T) { func TestStreamStop(t *testing.T) {
@ -82,7 +82,7 @@ func TestStreamStop(t *testing.T) {
if out.String() != "Stream stopped successfully.\n" { if out.String() != "Stream stopped successfully.\n" {
t.Fatalf("Expected output to contain 'Stream stopped successfully.', got '%s'", out.String()) t.Fatalf("Expected output to contain 'Stream stopped successfully.', got '%s'", out.String())
} }
time.Sleep(500 * time.Millisecond) // Wait for the stream to stop time.Sleep(2 * time.Second) // Wait for the stream to stop
} }
func TestStreamToggle(t *testing.T) { func TestStreamToggle(t *testing.T) {
@ -119,5 +119,5 @@ func TestStreamToggle(t *testing.T) {
t.Fatalf("Expected 'Stream started successfully.', got: %s", out.String()) t.Fatalf("Expected 'Stream started successfully.', got: %s", out.String())
} }
} }
time.Sleep(500 * time.Millisecond) // Wait for the stream to toggle time.Sleep(2 * time.Second) // Wait for the stream to toggle
} }

85
text.go
View File

@ -1,85 +0,0 @@
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,8 +2,38 @@ package main
import ( import (
"fmt" "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. // ObsVersionCmd handles the version command.
type ObsVersionCmd struct{} // size = 0x0 type ObsVersionCmd struct{} // size = 0x0