use red in example

move style section.

add imgs

CHANGELOG.md

@@ -5,11 +5,23 @@ 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.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
 

README.md

@@ -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
 
@@ -621,33 +661,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 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
-```
+`gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
 
 
 [userconfigdir]: https://pkg.go.dev/os#UserConfigDir

main.go

@@ -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"`
@@ -31,7 +46,7 @@ type StyleConfig struct {
 }
 
 // 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."`
@@ -81,10 +96,25 @@ 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)

record.go

@@ -204,6 +204,9 @@ func (cmd *RecordSplitCmd) Run(ctx *context) error {
 	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 {
@@ -229,6 +232,9 @@ func (cmd *RecordChapterCmd) Run(ctx *context) error {
 	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 == "" {

sceneitem.go

@@ -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:

version.go

@@ -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