mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-20 16:13:40 +00:00
Compare commits
8 Commits
v0.13.3
...
1c0ef025c1
| Author | SHA1 | Date | |
|---|---|---|---|
| 1c0ef025c1 | |||
| 2b7b8e0bd5 | |||
| 040ece840c | |||
| c6406888a9 | |||
| f65af8298d | |||
| 1dfb6f87ac | |||
| 866aedde7c | |||
| 9eb6c8a282 |
@@ -5,6 +5,12 @@ 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.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
|
||||
|
||||
18
README.md
18
README.md
@@ -77,7 +77,7 @@ gobs-cli --style="red" --no-border sceneitem list
|
||||
Or with environment variables:
|
||||
|
||||
```env
|
||||
GOBS_STYLE=cyan
|
||||
GOBS_STYLE=red
|
||||
GOBS_STYLE_NO_BORDER=true
|
||||
```
|
||||
|
||||
@@ -302,6 +302,22 @@ gobs-cli input unmute "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
|
||||
|
||||
- start: Start recording.
|
||||
|
||||
@@ -22,6 +22,7 @@ tasks:
|
||||
cmds:
|
||||
- task: build-windows
|
||||
- task: build-linux
|
||||
- task: build-macos
|
||||
|
||||
vet:
|
||||
desc: Vet the code
|
||||
@@ -46,6 +47,12 @@ tasks:
|
||||
- GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
|
||||
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:
|
||||
desc: Run tests
|
||||
cmds:
|
||||
|
||||
@@ -2,11 +2,20 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"strings"
|
||||
"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) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@@ -26,6 +35,8 @@ func TestGroupList(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGroupShow(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@@ -46,6 +57,8 @@ func TestGroupShow(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGroupToggle(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@@ -87,6 +100,8 @@ func TestGroupToggle(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGroupStatus(t *testing.T) {
|
||||
skipIfSkipGroupTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
|
||||
@@ -22,9 +22,8 @@ func TestInputList(t *testing.T) {
|
||||
expectedInputs := []string{
|
||||
"Desktop Audio",
|
||||
"Mic/Aux",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
output := out.String()
|
||||
for _, input := range expectedInputs {
|
||||
@@ -52,9 +51,8 @@ func TestInputListFilterInput(t *testing.T) {
|
||||
}
|
||||
expectedFilteredOut := []string{
|
||||
"Desktop Audio",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
@@ -86,9 +84,8 @@ func TestInputListFilterOutput(t *testing.T) {
|
||||
}
|
||||
expectedFilteredOut := []string{
|
||||
"Mic/Aux",
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
@@ -116,9 +113,8 @@ func TestInputListFilterColour(t *testing.T) {
|
||||
}
|
||||
|
||||
expectedInputs := []string{
|
||||
"Colour Source",
|
||||
"Colour Source 2",
|
||||
"Colour Source 3",
|
||||
"gobs-test-input",
|
||||
"gobs-test-input-2",
|
||||
}
|
||||
for _, input := range expectedInputs {
|
||||
if !strings.Contains(out.String(), input) {
|
||||
|
||||
1
main.go
1
main.go
@@ -59,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"`
|
||||
|
||||
39
main_test.go
39
main_test.go
@@ -2,7 +2,9 @@ package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"runtime"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/andreykaipov/goobs"
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
@@ -55,6 +57,22 @@ func TestMain(m *testing.M) {
|
||||
}
|
||||
|
||||
func setup(client *goobs.Client) {
|
||||
client.Config.CreateProfile(config.NewCreateProfileParams().
|
||||
WithProfileName("gobs-test-profile"))
|
||||
time.Sleep(2 * time.Second) // wait for profile creation to propagate
|
||||
client.Config.SetProfileParameter(config.NewSetProfileParameterParams().
|
||||
WithParameterCategory("SimpleOutput").
|
||||
WithParameterName("RecRB").
|
||||
WithParameterValue("true"))
|
||||
client.Config.SetProfileParameter(config.NewSetProfileParameterParams().
|
||||
WithParameterCategory("AdvOut").
|
||||
WithParameterName("RecRB").
|
||||
WithParameterValue("true"))
|
||||
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
|
||||
WithProfileName("Untitled"))
|
||||
client.Config.SetCurrentProfile(config.NewSetCurrentProfileParams().
|
||||
WithProfileName("gobs-test-profile"))
|
||||
|
||||
client.Config.SetStreamServiceSettings(config.NewSetStreamServiceSettingsParams().
|
||||
WithStreamServiceType("rtmp_common").
|
||||
WithStreamServiceSettings(&typedefs.StreamServiceSettings{
|
||||
@@ -90,6 +108,24 @@ func setup(client *goobs.Client) {
|
||||
}).
|
||||
WithSceneItemEnabled(true))
|
||||
|
||||
// ensure Desktop Audio input is created
|
||||
var inputKind string
|
||||
switch runtime.GOOS {
|
||||
case "windows":
|
||||
inputKind = "wasapi_output_capture"
|
||||
case "linux":
|
||||
inputKind = "pulse_output_capture"
|
||||
case "darwin":
|
||||
inputKind = "coreaudio_output_capture"
|
||||
}
|
||||
client.Inputs.CreateInput(inputs.NewCreateInputParams().
|
||||
WithSceneName("gobs-test").
|
||||
WithInputName("Desktop Audio").
|
||||
WithInputKind(inputKind).
|
||||
WithInputSettings(map[string]any{
|
||||
"device_id": "default",
|
||||
}))
|
||||
|
||||
// Create source filter on an audio input
|
||||
client.Filters.CreateSourceFilter(filters.NewCreateSourceFilterParams().
|
||||
WithSourceName("Mic/Aux").
|
||||
@@ -115,6 +151,9 @@ func setup(client *goobs.Client) {
|
||||
}
|
||||
|
||||
func teardown(client *goobs.Client) {
|
||||
client.Config.RemoveProfile(config.NewRemoveProfileParams().
|
||||
WithProfileName("gobs-test-profile"))
|
||||
|
||||
client.Filters.RemoveSourceFilter(filters.NewRemoveSourceFilterParams().
|
||||
WithSourceName("Mic/Aux").
|
||||
WithFilterName("test_filter"))
|
||||
|
||||
@@ -2,11 +2,20 @@ package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
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) {
|
||||
skipIfSkipReplayBufferTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@@ -24,6 +33,8 @@ func TestReplayBufferStart(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestReplayBufferStop(t *testing.T) {
|
||||
skipIfSkipReplayBufferTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
@@ -41,6 +52,8 @@ func TestReplayBufferStop(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestReplayBufferToggle(t *testing.T) {
|
||||
skipIfSkipReplayBufferTests(t)
|
||||
|
||||
client, disconnect := getClient(t)
|
||||
defer disconnect()
|
||||
|
||||
|
||||
85
text.go
Normal file
85
text.go
Normal 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
|
||||
}
|
||||
Reference in New Issue
Block a user