add short names for root options

fix flag example in readme

CHANGELOG.md

@@ -5,6 +5,27 @@ 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.9.0]
+
+### Added
+
+-   --version/-v option. See [VersionFlag](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#versionflag)
+
+### Changed
+
+-   version command renamed to obs-version
+
+# [0.8.2]
+
+### Added
+
+-   record start/stop and stream start/stop commands check outputActive states first. 
+    -   Errors are returned if the command cannot be performed.
+
+### Changed
+
+-   The --parent flag for the sceneitem commands has been renamed to --group, see [SceneItemCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#sceneitemcmd)
+
 # [0.8.0] - 2025-05-27
 
 ### Added

README.md

@@ -14,10 +14,16 @@ go install github.com/onyx-and-iris/gobs-cli@latest
 
 #### Flags
 
-Pass `--host`, `--port` and `--password` as flags to the root command, for example:
+-   --host/-H: Websocket host
+-   --port/-P Websocket port
+-   --password/-p: Websocket password
+-   --timeout/-T: Websocket timeout
+-   --version/-v: Print the gobs-cli version
+
+Pass `--host`, `--port` and `--password` as flags on the root command, for example:
 
 ```console
-gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
+gobs-cli --host localhost --port 4455 --password 'websocket password' --help
 ```
 
 #### Environment Variables
@@ -37,10 +43,12 @@ OBS_TIMEOUT=5
 
 ## Commands
 
-### VersionCmd
+### ObsVersionCmd
+
+-   Print OBS client and websocket version.
 
 ```console
-gobs-cli version
+gobs-cli obs-version
 ```
 
 ### SceneCmd
@@ -94,7 +102,7 @@ gobs-cli sceneitem list LIVE
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
@@ -105,7 +113,7 @@ gobs-cli sceneitem show START "Colour Source"
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
@@ -116,29 +124,29 @@ gobs-cli sceneitem hide START "Colour Source"
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
-gobs-cli sceneitem toggle --parent=test_group START "Colour Source 3"
+gobs-cli sceneitem toggle --group=test_group START "Colour Source 3"
 ```
 
 -   visible: Get scene item visibility.
     -   flags:
 
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
     -   args: SceneName ItemName
 
 ```console
-gobs-cli sceneitem visible --parent=test_group START "Colour Source 4"
+gobs-cli sceneitem visible --group=test_group START "Colour Source 4"
 ```
 
 -   transform: Transform scene item.
     -   flags:
         
         *optional*
-        -   --parent: Parent group name.
+        -   --group: Parent group name.
 
         -   --alignment: Alignment of the scene item.
         -   --bounds-alignment: Bounds alignment of the scene item.
@@ -557,7 +565,7 @@ gobs-cli projector list-monitors
         -   defaults to current scene
 
 ```console
-gobs-cli project open
+gobs-cli projector open
 
 gobs-cli projector open --monitor-index=1 "test_scene"
 

Taskfile.yaml

@@ -35,13 +35,13 @@ tasks:
   build-windows:
     desc: Build the gobs-cli project for Windows
     cmds:
-      - GOOS=windows GOARCH=amd64 go build -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
+      - GOOS=windows GOARCH=amd64 go build -ldflags "-X 'main.version=debug'" -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
     internal: true
 
   build-linux:
     desc: Build the gobs-cli project for Linux
     cmds:
-      - GOOS=linux GOARCH=amd64 go build -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
+      - GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version=debug'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
     internal: true
 
   test:

main.go

@@ -18,10 +18,10 @@ import (
 
 // 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"`
+	Host     string `flag:"host"     help:"Host to connect to."          default:"localhost" env:"OBS_HOST"     short:"H"`
-	Port     int    `flag:"port"     help:"Port to connect to."          default:"4455"      env:"OBS_PORT"`
+	Port     int    `flag:"port"     help:"Port to connect to."          default:"4455"      env:"OBS_PORT"     short:"P"`
-	Password string `flag:"password" help:"Password for authentication." default:""          env:"OBS_PASSWORD"`
+	Password string `flag:"password" help:"Password for authentication." default:""          env:"OBS_PASSWORD" short:"p"`
-	Timeout  int    `flag:"timeout"  help:"Timeout in seconds."          default:"5"         env:"OBS_TIMEOUT"`
+	Timeout  int    `flag:"timeout"  help:"Timeout in seconds."          default:"5"         env:"OBS_TIMEOUT"  short:"T"`
 }
 
 // CLI is the main command line interface structure.
@@ -29,23 +29,24 @@ type ObsConfig struct {
 type CLI struct {
 	ObsConfig `embed:"" help:"OBS WebSocket configuration."`
 
-	Man mangokong.ManFlag `help:"Print man page."`
+	Man     mangokong.ManFlag `help:"Print man page."`
+	Version VersionFlag       `help:"Print gobs-cli version information and quit" name:"version" short:"v"`
 
-	Version         VersionCmd         `help:"Show version."             cmd:"" aliases:"v"`
+	ObsVersion      ObsVersionCmd      `help:"Print OBS client and websocket version." cmd:"" aliases:"v"`
-	Scene           SceneCmd           `help:"Manage scenes."            cmd:"" aliases:"sc"`
+	Scene           SceneCmd           `help:"Manage scenes."                          cmd:"" aliases:"sc"`
-	Sceneitem       SceneItemCmd       `help:"Manage scene items."       cmd:"" aliases:"si"`
+	Sceneitem       SceneItemCmd       `help:"Manage scene items."                     cmd:"" aliases:"si"`
-	Group           GroupCmd           `help:"Manage groups."            cmd:"" aliases:"g"`
+	Group           GroupCmd           `help:"Manage groups."                          cmd:"" aliases:"g"`
-	Input           InputCmd           `help:"Manage inputs."            cmd:"" aliases:"i"`
+	Input           InputCmd           `help:"Manage inputs."                          cmd:"" aliases:"i"`
-	Record          RecordCmd          `help:"Manage recording."         cmd:"" aliases:"rec"`
+	Record          RecordCmd          `help:"Manage recording."                       cmd:"" aliases:"rec"`
-	Stream          StreamCmd          `help:"Manage streaming."         cmd:"" aliases:"st"`
+	Stream          StreamCmd          `help:"Manage streaming."                       cmd:"" aliases:"st"`
-	Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn"`
+	Scenecollection SceneCollectionCmd `help:"Manage scene collections."               cmd:"" aliases:"scn"`
-	Profile         ProfileCmd         `help:"Manage profiles."          cmd:"" aliases:"p"`
+	Profile         ProfileCmd         `help:"Manage profiles."                        cmd:"" aliases:"p"`
-	Replaybuffer    ReplayBufferCmd    `help:"Manage replay buffer."     cmd:"" aliases:"rb"`
+	Replaybuffer    ReplayBufferCmd    `help:"Manage replay buffer."                   cmd:"" aliases:"rb"`
-	Studiomode      StudioModeCmd      `help:"Manage studio mode."       cmd:"" aliases:"sm"`
+	Studiomode      StudioModeCmd      `help:"Manage studio mode."                     cmd:"" aliases:"sm"`
-	Virtualcam      VirtualCamCmd      `help:"Manage virtual camera."    cmd:"" aliases:"vc"`
+	Virtualcam      VirtualCamCmd      `help:"Manage virtual camera."                  cmd:"" aliases:"vc"`
-	Hotkey          HotkeyCmd          `help:"Manage hotkeys."           cmd:"" aliases:"hk"`
+	Hotkey          HotkeyCmd          `help:"Manage hotkeys."                         cmd:"" aliases:"hk"`
-	Filter          FilterCmd          `help:"Manage filters."           cmd:"" aliases:"f"`
+	Filter          FilterCmd          `help:"Manage filters."                         cmd:"" aliases:"f"`
-	Projector       ProjectorCmd       `help:"Manage projectors."        cmd:"" aliases:"prj"`
+	Projector       ProjectorCmd       `help:"Manage projectors."                      cmd:"" aliases:"prj"`
 }
 
 type context struct {

record_test.go

@@ -35,8 +35,8 @@ func TestRecordStart(t *testing.T) {
 		if err == nil {
 			t.Fatalf("Expected error when starting recording while active, got nil")
 		}
-		if !strings.Contains(err.Error(), "Recording is already in progress") {
+		if !strings.Contains(err.Error(), "recording is already in progress") {
-			t.Fatalf("Expected error message to contain 'Recording is already in progress', got '%s'", err.Error())
+			t.Fatalf("Expected error message to contain 'recording is already in progress', got '%s'", err.Error())
 		}
 		return
 	}

sceneitem.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"sort"
 
 	"github.com/andreykaipov/goobs"
 	"github.com/andreykaipov/goobs/api/requests/sceneitems"
@@ -46,31 +47,57 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
 
 	t := table.New(ctx.Out)
 	t.SetPadding(3)
-	t.SetAlignment(table.AlignLeft)
+	t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter, table.AlignCenter)
-	t.SetHeaders("Item Name")
+	t.SetHeaders("Item ID", "Item Name", "In Group", "Enabled")
+
+	sort.Slice(resp.SceneItems, func(i, j int) bool {
+		return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
+	})
 
 	for _, item := range resp.SceneItems {
-		t.AddRow(item.SourceName)
+		if item.IsGroup {
+			resp, err := ctx.Client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
+				WithSceneName(item.SourceName))
+			if err != nil {
+				return fmt.Errorf("failed to get group scene item list for '%s': %w", item.SourceName, err)
+			}
+
+			sort.Slice(resp.SceneItems, func(i, j int) bool {
+				return resp.SceneItems[i].SceneItemID < resp.SceneItems[j].SceneItemID
+			})
+
+			for _, groupItem := range resp.SceneItems {
+				t.AddRow(
+					fmt.Sprintf("%d", groupItem.SceneItemID),
+					groupItem.SourceName,
+					item.SourceName,
+					fmt.Sprintf("%t", item.SceneItemEnabled && groupItem.SceneItemEnabled),
+				)
+			}
+		} else {
+			t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", fmt.Sprintf("%t", item.SceneItemEnabled))
+		}
 	}
 	t.Render()
 	return nil
 }
 
+// getSceneNameAndItemID retrieves the scene name and item ID for a given item in a scene or group.
 func getSceneNameAndItemID(
 	client *goobs.Client,
 	sceneName string,
 	itemName string,
-	parent string,
+	group string,
 ) (string, int, error) {
-	if parent != "" {
+	if group != "" {
 		resp, err := client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
-			WithSceneName(parent))
+			WithSceneName(group))
 		if err != nil {
 			return "", 0, err
 		}
 		for _, item := range resp.SceneItems {
 			if item.SourceName == itemName {
-				return parent, int(item.SceneItemID), nil
+				return group, int(item.SceneItemID), nil
 			}
 		}
 		return "", 0, fmt.Errorf("item '%s' not found in scene '%s'", itemName, sceneName)
@@ -87,7 +114,7 @@ func getSceneNameAndItemID(
 
 // SceneItemShowCmd provides a command to show a scene item.
 type SceneItemShowCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -95,7 +122,7 @@ type SceneItemShowCmd struct {
 
 // Run executes the command to show a scene item.
 func (cmd *SceneItemShowCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -108,8 +135,8 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
 		return err
 	}
 
-	if cmd.Parent != "" {
+	if cmd.Group != "" {
-		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Parent)
+		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Group)
 	} else {
 		fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now visible.\n", cmd.ItemName, cmd.SceneName)
 	}
@@ -119,7 +146,7 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
 
 // SceneItemHideCmd provides a command to hide a scene item.
 type SceneItemHideCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -127,7 +154,7 @@ type SceneItemHideCmd struct {
 
 // Run executes the command to hide a scene item.
 func (cmd *SceneItemHideCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -140,8 +167,8 @@ func (cmd *SceneItemHideCmd) Run(ctx *context) error {
 		return err
 	}
 
-	if cmd.Parent != "" {
+	if cmd.Group != "" {
-		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Parent)
+		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Group)
 	} else {
 		fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now hidden.\n", cmd.ItemName, cmd.SceneName)
 	}
@@ -162,7 +189,7 @@ func getItemEnabled(client *goobs.Client, sceneName string, itemID int) (bool, e
 
 // SceneItemToggleCmd provides a command to toggle the visibility of a scene item.
 type SceneItemToggleCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -170,7 +197,7 @@ type SceneItemToggleCmd struct {
 
 // Run executes the command to toggle the visibility of a scene item.
 func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -199,7 +226,7 @@ func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
 
 // SceneItemVisibleCmd provides a command to check the visibility of a scene item.
 type SceneItemVisibleCmd struct {
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
@@ -207,7 +234,7 @@ type SceneItemVisibleCmd struct {
 
 // Run executes the command to check the visibility of a scene item.
 func (cmd *SceneItemVisibleCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -230,7 +257,7 @@ type SceneItemTransformCmd struct {
 	SceneName string `arg:"" help:"Scene name."`
 	ItemName  string `arg:"" help:"Item name."`
 
-	Parent string `flag:"" help:"Parent group name."`
+	Group string `flag:"" help:"Parent group name."`
 
 	Alignment       float64 `flag:"" help:"Alignment of the scene item."`
 	BoundsAlignment float64 `flag:"" help:"Bounds alignment of the scene item."`
@@ -251,7 +278,7 @@ type SceneItemTransformCmd struct {
 
 // Run executes the command to transform a scene item.
 func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
-	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Parent)
+	sceneName, sceneItemID, err := getSceneNameAndItemID(ctx.Client, cmd.SceneName, cmd.ItemName, cmd.Group)
 	if err != nil {
 		return err
 	}
@@ -323,8 +350,8 @@ func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
 		return err
 	}
 
-	if cmd.Parent != "" {
+	if cmd.Group != "" {
-		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Parent)
+		fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Group)
 	} else {
 		fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' transformed.\n", cmd.ItemName, cmd.SceneName)
 	}

version.go

@@ -2,13 +2,33 @@ package main
 
 import (
 	"fmt"
+
+	"github.com/alecthomas/kong"
 )
 
-// VersionCmd handles the version command.
+var version = "unknown"
-type VersionCmd struct{} // size = 0x0
+
+// VersionFlag is a custom flag type for displaying version information.
+type VersionFlag string
+
+// Decode implements the kong.Flag interface for VersionFlag.
+func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
+
+// IsBool implements the kong.Flag interface for VersionFlag.
+func (v VersionFlag) IsBool() bool { return true }
+
+// BeforeApply implements the kong.Flag interface for VersionFlag.
+func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error { // nolint: unparam
+	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
 
 // Run executes the command to get the OBS client version.
-func (cmd *VersionCmd) Run(ctx *context) error {
+func (cmd *ObsVersionCmd) Run(ctx *context) error {
 	version, err := ctx.Client.General.GetVersion()
 	if err != nil {
 		return err

version_test.go

@@ -16,7 +16,7 @@ func TestVersion(t *testing.T) {
 		Out:    &out,
 	}
 
-	cmd := &VersionCmd{}
+	cmd := &ObsVersionCmd{}
 	err := cmd.Run(context)
 	if err != nil {
 		t.Fatalf("Failed to get version: %v", err)