Compare commits

..

3 Commits

Author SHA1 Message Date
b0437b1656 remove --show flag from settings video
update README
2026-01-09 12:43:58 +00:00
30f40aee2e make Type arg optional, if not passed print current stream service settings.
this is a bugfix.
2026-01-09 12:11:09 +00:00
6eb8a5ffed implement mediainput command group
note, set-cursor not currently working, possible bug in goobs
2026-01-08 20:38:36 +00:00
7 changed files with 37 additions and 159 deletions

View File

@@ -5,13 +5,7 @@ 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.17.0] - 2026-01-09
### Added
- media command group, see [MediaCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#mediacmd)
# [0.16.2] - 2026-01-08
# [0.16.2] - 2026-01-26
### Added

View File

@@ -12,7 +12,6 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
- [Configuration](#configuration)
- [Style](#style)
- [Commands](#commands)
- [Shell Completion](#shell-completion)
- [License](#license)
## Installation
@@ -780,60 +779,6 @@ gobs-cli settings video
gobs-cli settings video --base-width=1920 --base-height=1080
```
### MediaCmd
- cursor: Get/set the cursor position of a media input.
- args: InputName
*optional*
- TimeString
```console
gobs-cli media cursor "Media"
gobs-cli media cursor "Media" "00:08:30"
```
- play: Plays a media input.
```console
gobs-cli media play "Media"
```
- pause: Pauses a media input.
```console
gobs-cli media pause "Media"
```
- stop: Stops a media input.
```console
gobs-cli media stop "Media"
```
- restart: Restarts a media input.
```console
gobs-cli media restart "Media"
```
## Shell Completion
- completion:
*optional*
- args: Shell
```console
gobs-cli completion
gobs-cli completion bash
```
Currently supported shells: *bash* *zsh* *fish*. If no shell is passed completion will attempt to detect the current user shell.
## License

9
go.mod
View File

@@ -1,13 +1,12 @@
module github.com/onyx-and-iris/gobs-cli
go 1.25
go 1.24.0
require (
github.com/alecthomas/kong v1.13.0
github.com/alecthomas/kong v1.10.0
github.com/alecthomas/mango-kong v0.1.0
github.com/andreykaipov/goobs v1.5.6
github.com/charmbracelet/lipgloss v1.1.0
github.com/jotaen/kong-completion v0.0.9
github.com/titusjaka/kong-dotenv-go v0.1.0
)
@@ -19,8 +18,6 @@ require (
github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
github.com/charmbracelet/x/term v0.2.1 // indirect
github.com/gorilla/websocket v1.5.3 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
github.com/hashicorp/logutils v1.0.0 // indirect
github.com/joho/godotenv v1.5.1 // indirect
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
@@ -32,9 +29,7 @@ require (
github.com/muesli/roff v0.1.0 // indirect
github.com/muesli/termenv v0.16.0 // indirect
github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect
github.com/posener/complete v1.2.3 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab // indirect
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
golang.org/x/sys v0.30.0 // indirect
)

29
go.sum
View File

@@ -1,11 +1,11 @@
github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8vS6K3D0=
github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
github.com/alecthomas/kong v1.13.0 h1:5e/7XC3ugvhP1DQBmTS+WuHtCbcv44hsohMgcvVxSrA=
github.com/alecthomas/kong v1.13.0/go.mod h1:wrlbXem1CWqUV5Vbmss5ISYhsVPkBb1Yo7YKJghju2I=
github.com/alecthomas/kong v1.10.0 h1:8K4rGDpT7Iu+jEXCIJUeKqvpwZHbsFRoebLbnzlmrpw=
github.com/alecthomas/kong v1.10.0/go.mod h1:p2vqieVMeTAnaC83txKtXe8FLke2X07aruPWXyMPQrU=
github.com/alecthomas/mango-kong v0.1.0 h1:iFVfP1k1K4qpml3JUQmD5I8MCQYfIvsD9mRdrw7jJC4=
github.com/alecthomas/mango-kong v0.1.0/go.mod h1:t+TYVdsONUolf/BwVcm+15eqcdAj15h4Qe9MMFAwwT4=
github.com/alecthomas/repr v0.5.2 h1:SU73FTI9D1P5UNtvseffFSGmdNci/O6RsqzeXJtP0Qs=
github.com/alecthomas/repr v0.5.2/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc=
github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
github.com/andreykaipov/goobs v1.5.6 h1:eIkEqYN99+2VJvmlY/56Ah60nkRKS6efMQvpM3oUgPQ=
github.com/andreykaipov/goobs v1.5.6/go.mod h1:iSZP93FJ4d9X/U1x4DD4IyILLtig+vViqZWBGjLywcY=
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
@@ -26,25 +26,16 @@ github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a h1:G99k
github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk=
github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=
github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=
github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y=
github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
github.com/jotaen/kong-completion v0.0.9 h1:yXKSRvjWuuZlTGpPMpvo96sFjh5PEh/skrcK4DjJnfg=
github.com/jotaen/kong-completion v0.0.9/go.mod h1:dyIG20e3qq128SUBtF8jzI7YtkfzjWMlgbqkAJd6xHQ=
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
@@ -65,17 +56,11 @@ github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/
github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d/go.mod h1:YUTz3bUH2ZwIWBy3CJBeOBEugqcmXREj14T+iG/4k4U=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/posener/complete v1.2.3 h1:NP0eAhjcjImqslEwo/1hq7gpajME0fTLTezBKDqfXqo=
github.com/posener/complete v1.2.3/go.mod h1:WZIdtGGp+qx0sLrYKtIRAruyNpv6hFCicSgv7Sy7s/s=
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab h1:ZjX6I48eZSFetPb41dHudEyVr5v953N15TsNZXlkcWY=
github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab/go.mod h1:/PfPXh0EntGc3QAAyUaviy4S9tzy4Zp0e2ilq4voC6E=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/titusjaka/kong-dotenv-go v0.1.0 h1:TmUjP/sXoNiKLr6oR7n9xrB5XyXi/Ssuebzfz5nxZj4=
github.com/titusjaka/kong-dotenv-go v0.1.0/go.mod h1:pBgLjcu82oqUgb7+bngK9+Ch7jg49E0YADP8Wnj2MXU=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
@@ -85,7 +70,5 @@ golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@@ -15,7 +15,6 @@ import (
"github.com/alecthomas/kong"
mangokong "github.com/alecthomas/mango-kong"
"github.com/andreykaipov/goobs"
kongcompletion "github.com/jotaen/kong-completion"
kongdotenv "github.com/titusjaka/kong-dotenv-go"
)
@@ -55,8 +54,6 @@ type CLI struct {
Man mangokong.ManFlag `help:"Print man page."`
Version VersionFlag `help:"Print gobs-cli version information and quit" name:"version" short:"v"`
Completion kongcompletion.Completion `help:"Generate shell completion scripts." cmd:"" aliases:"c"`
ObsVersion ObsVersionCmd `help:"Print OBS client and websocket version." cmd:"" aliases:"v"`
Scene SceneCmd `help:"Manage scenes." cmd:"" aliases:"sc" group:"Scene"`
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"`
@@ -75,7 +72,7 @@ type CLI struct {
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj" group:"Projector"`
Screenshot ScreenshotCmd `help:"Take screenshots." cmd:"" aliases:"ss" group:"Screenshot"`
Settings SettingsCmd `help:"Manage video and profile settings." cmd:"" aliases:"set" group:"Settings"`
Media MediaCmd `help:"Manage media inputs." cmd:"" aliases:"mi" group:"Media Input"`
Mediainput Mediainput `help:"Manage media inputs." cmd:"" aliases:"mi" group:"Media Input"`
}
type context struct {
@@ -100,7 +97,6 @@ func main() {
}
var cli CLI
kongcompletion.Register(kong.Must(&cli))
ctx := kong.Parse(
&cli,
kong.Name("gobs-cli"),

View File

@@ -6,41 +6,24 @@ import (
"github.com/andreykaipov/goobs/api/requests/mediainputs"
)
// MediaCmd represents a collection of commands to control media inputs.
type MediaCmd struct {
Cursor MediaCursorCmd `cmd:"" help:"Get/set the cursor position of a media input." aliases:"c"`
Play MediaPlayCmd `cmd:"" help:"Plays a media input." aliases:"p"`
Pause MediaPauseCmd `cmd:"" help:"Pauses a media input." aliases:"pa"`
Stop MediaStopCmd `cmd:"" help:"Stops a media input." aliases:"s"`
Restart MediaRestartCmd `cmd:"" help:"Restarts a media input." aliases:"r"`
// Mediainput represents a collection of commands to control media inputs.
type Mediainput struct {
SetCursor MediainputSetCursorCmd `cmd:"" help:"Sets the cursor position of a media input."`
Play MediainputPlayCmd `cmd:"" help:"Plays a media input."`
Pause MediainputPauseCmd `cmd:"" help:"Pauses a media input."`
Stop MediainputStopCmd `cmd:"" help:"Stops a media input."`
Restart MediainputRestartCmd `cmd:"" help:"Restarts a media input."`
}
// MediaCursorCmd represents the command to get or set the cursor position of a media input.
type MediaCursorCmd struct {
// MediainputSetCursorCmd represents the command to set the cursor position of a media input.
type MediainputSetCursorCmd struct {
InputName string `arg:"" help:"Name of the media input."`
TimeString string `arg:"" help:"Time position to set the cursor to (e.g., '00:01:30' for 1 minute 30 seconds). If not provided, the current cursor position will be displayed." optional:""`
TimeString string `arg:"" help:"Time position to set the cursor to (e.g., '00:01:30' for 1 minute 30 seconds)."`
}
// Run executes the command to set the cursor position of the media input.
func (cmd *MediaCursorCmd) Run(ctx *context) error {
if cmd.TimeString == "" {
resp, err := ctx.Client.MediaInputs.GetMediaInputStatus(
mediainputs.NewGetMediaInputStatusParams().
WithInputName(cmd.InputName))
if err != nil {
return fmt.Errorf("failed to get media input cursor: %w", err)
}
fmt.Fprintf(
ctx.Out,
"%s cursor position: %s\n",
ctx.Style.Highlight(cmd.InputName),
formatMillisecondsToTimeString(resp.MediaCursor),
)
return nil
}
position, err := parseTimeStringToMilliseconds(cmd.TimeString)
func (cmd *MediainputSetCursorCmd) Run(ctx *context) error {
position, err := parseTimeStringToSeconds(cmd.TimeString)
if err != nil {
return fmt.Errorf("failed to parse time string: %w", err)
}
@@ -53,23 +36,17 @@ func (cmd *MediaCursorCmd) Run(ctx *context) error {
return fmt.Errorf("failed to set media input cursor: %w", err)
}
fmt.Fprintf(
ctx.Out,
"Set %s cursor to %s (%.0f ms)\n",
ctx.Style.Highlight(cmd.InputName),
ctx.Style.Highlight(cmd.TimeString),
position,
)
fmt.Fprintln(ctx.Out, "Set media input cursor to position (seconds):", position)
return nil
}
// MediaPlayCmd represents the command to play a media input.
type MediaPlayCmd struct {
// MediainputPlayCmd represents the command to play a media input.
type MediainputPlayCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to play the media input.
func (cmd *MediaPlayCmd) Run(ctx *context) error {
func (cmd *MediainputPlayCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
@@ -82,13 +59,13 @@ func (cmd *MediaPlayCmd) Run(ctx *context) error {
return nil
}
// MediaPauseCmd represents the command to pause a media input.
type MediaPauseCmd struct {
// MediainputPauseCmd represents the command to pause a media input.
type MediainputPauseCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to pause the media input.
func (cmd *MediaPauseCmd) Run(ctx *context) error {
func (cmd *MediainputPauseCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
@@ -101,13 +78,13 @@ func (cmd *MediaPauseCmd) Run(ctx *context) error {
return nil
}
// MediaStopCmd represents the command to stop a media input.
type MediaStopCmd struct {
// MediainputStopCmd represents the command to stop a media input.
type MediainputStopCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to stop the media input.
func (cmd *MediaStopCmd) Run(ctx *context) error {
func (cmd *MediainputStopCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).
@@ -120,13 +97,13 @@ func (cmd *MediaStopCmd) Run(ctx *context) error {
return nil
}
// MediaRestartCmd represents the command to restart a media input.
type MediaRestartCmd struct {
// MediainputRestartCmd represents the command to restart a media input.
type MediainputRestartCmd struct {
InputName string `arg:"" help:"Name of the media input."`
}
// Run executes the command to restart the media input.
func (cmd *MediaRestartCmd) Run(ctx *context) error {
func (cmd *MediainputRestartCmd) Run(ctx *context) error {
_, err := ctx.Client.MediaInputs.TriggerMediaInputAction(
mediainputs.NewTriggerMediaInputActionParams().
WithInputName(cmd.InputName).

16
util.go
View File

@@ -39,7 +39,7 @@ func trimPrefix(s, prefix string) string {
return s
}
func parseTimeStringToMilliseconds(timeStr string) (float64, error) {
func parseTimeStringToSeconds(timeStr string) (float64, error) {
parts := strings.Split(timeStr, ":")
var durationStr string
@@ -62,17 +62,5 @@ func parseTimeStringToMilliseconds(timeStr string) (float64, error) {
return 0, fmt.Errorf("failed to parse duration: %w", err)
}
return duration.Seconds() * 1000, nil
}
func formatMillisecondsToTimeString(ms float64) string {
totalSeconds := int(ms / 1000)
hours := totalSeconds / 3600
minutes := (totalSeconds % 3600) / 60
seconds := totalSeconds % 60
if hours > 0 {
return fmt.Sprintf("%02d:%02d:%02d", hours, minutes, seconds)
}
return fmt.Sprintf("%02d:%02d", minutes, seconds)
return duration.Seconds(), nil
}