add 0.4.0 to changelog

move man tasks into Taskfile.man.yaml

.gitignore

@@ -26,5 +26,15 @@ go.work
 
 # End of gignore: github.com/onyx-and-iris/gignore
 
+# Environment
+.env
 .envrc
+
+# Man pages
+gobs-cli.1
+
+# Config files
+config.yaml
+
+# Test files
 *_test.go

CHANGELOG.md

@@ -5,6 +5,19 @@ 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.4.0] - 2025-05-07
+
+### Added
+
+-   replaybuffer toggle command
+
+# [0.3.1] - 2025-05-02
+
+### Added
+
+-   --man flag for generating/viewing a man page.
+-   Ability to load env vars from env files, see the [README](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#environment-variables)
+
 # [0.2.0] - 2025-04-27
 
 ### Added

README.md

@@ -22,17 +22,19 @@ gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
 
 #### Environment Variables
 
-Load connection details from your environment:
+Store and load environment variables from:
 
-```bash
+-   A `.env` file in the cwd
-#!/usr/bin/env bash
+-   $XDG_CONFIG_HOME / gobs-cli / config.env (see [os.UserConfigDir][userconfigdir])
 
-export OBS_HOST=localhost
+```env
-export OBS_PORT=4455
+OBS_HOST=localhost
-export OBS_PASSWORD=<websocket password>
+OBS_PORT=4455
-export OBS_TIMEOUT=5
+OBS_PASSWORD=<websocket password>
+OBS_TIMEOUT=5
 ```
 
+
 ## Commands
 
 ### VersionCmd
@@ -434,3 +436,5 @@ gobs-cli virtualcam toggle
 ```console
 gobs-cli virtualcam status
 ```
+
+[userconfigdir]: https://pkg.go.dev/os#UserConfigDir

Taskfile.man.yaml

@@ -0,0 +1,17 @@
+version: '3'
+
+tasks:
+  default:
+    desc: View man page
+    cmds:
+      - task: view
+
+  view:
+    desc: View man page
+    cmds:
+      - go run . --man | man -l -
+
+  generate:
+    desc: Generate man page
+    cmds:
+      - go run . --man > {{.PROGRAM}}.1

Taskfile.yaml

@@ -1,5 +1,8 @@
 version: '3'
 
+includes:
+  man: Taskfile.man.yaml
+
 vars:
   PROGRAM: gobs-cli
   SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
@@ -50,8 +53,3 @@ tasks:
     desc: Clean the build artifacts
     cmds:
       - '{{.SHELL}} rm -r {{.BIN_DIR}}'
-
-  manfile:
-    desc: Generate manfile
-    cmds:
-      - go run . --man > manfile

go.mod

@@ -6,12 +6,14 @@ require (
 	github.com/alecthomas/kong v1.10.0
 	github.com/alecthomas/mango-kong v0.1.0
 	github.com/andreykaipov/goobs v1.5.6
+	github.com/titusjaka/kong-dotenv-go v0.1.0
 )
 
 require (
 	github.com/buger/jsonparser v1.1.1 // indirect
 	github.com/gorilla/websocket v1.5.3 // indirect
 	github.com/hashicorp/logutils v1.0.0 // indirect
+	github.com/joho/godotenv v1.5.1 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mmcloughlin/profile v0.1.1 // indirect
 	github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab // indirect

go.sum

@@ -18,6 +18,8 @@ github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI
 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/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/mmcloughlin/profile v0.1.1 h1:jhDmAqPyebOsVDOCICJoINoLb/AnLBaUw58nFzxWS2w=
@@ -32,5 +34,7 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 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=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

main.go

@@ -7,11 +7,13 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"path/filepath"
 	"time"
 
 	"github.com/alecthomas/kong"
 	mangokong "github.com/alecthomas/mango-kong"
 	"github.com/andreykaipov/goobs"
+	kongdotenv "github.com/titusjaka/kong-dotenv-go"
 )
 
 // ObsConfig holds the configuration for connecting to the OBS WebSocket server.
@@ -49,11 +51,18 @@ type context struct {
 }
 
 func main() {
-	cli := cli{}
+	userConfigDir, err := os.UserConfigDir()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error getting user config directory: %v\n", err)
+		os.Exit(1)
+	}
+
+	var cli cli
 	ctx := kong.Parse(
 		&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")),
 	)
 
 	client, err := connectObs(cli.ObsConfig)

profile.go

@@ -9,18 +9,18 @@ import (
 
 // ProfileCmd provides commands to manage profiles in OBS Studio.
 type ProfileCmd struct {
-	List    ListProfileCmd    `help:"List profiles."       cmd:"" aliases:"ls"`
+	List    ProfileListCmd    `help:"List profiles."       cmd:"" aliases:"ls"`
-	Current CurrentProfileCmd `help:"Get current profile." cmd:"" aliases:"c"`
+	Current ProfileCurrentCmd `help:"Get current profile." cmd:"" aliases:"c"`
-	Switch  SwitchProfileCmd  `help:"Switch profile."      cmd:"" aliases:"sw"`
+	Switch  ProfileSwitchCmd  `help:"Switch profile."      cmd:"" aliases:"sw"`
-	Create  CreateProfileCmd  `help:"Create profile."      cmd:"" aliases:"new"`
+	Create  ProfileCreateCmd  `help:"Create profile."      cmd:"" aliases:"new"`
-	Remove  RemoveProfileCmd  `help:"Remove profile."      cmd:"" aliases:"rm"`
+	Remove  ProfileRemoveCmd  `help:"Remove profile."      cmd:"" aliases:"rm"`
 }
 
-// ListProfileCmd provides a command to list all profiles.
+// ProfileListCmd provides a command to list all profiles.
-type ListProfileCmd struct{} // size = 0x0
+type ProfileListCmd struct{} // size = 0x0
 
 // Run executes the command to list all profiles.
-func (cmd *ListProfileCmd) Run(ctx *context) error {
+func (cmd *ProfileListCmd) Run(ctx *context) error {
 	profiles, err := ctx.Client.Config.GetProfileList()
 	if err != nil {
 		return err
@@ -33,11 +33,11 @@ func (cmd *ListProfileCmd) Run(ctx *context) error {
 	return nil
 }
 
-// CurrentProfileCmd provides a command to get the current profile.
+// ProfileCurrentCmd provides a command to get the current profile.
-type CurrentProfileCmd struct{} // size = 0x0
+type ProfileCurrentCmd struct{} // size = 0x0
 
 // Run executes the command to get the current profile.
-func (cmd *CurrentProfileCmd) Run(ctx *context) error {
+func (cmd *ProfileCurrentCmd) Run(ctx *context) error {
 	profiles, err := ctx.Client.Config.GetProfileList()
 	if err != nil {
 		return err
@@ -47,13 +47,13 @@ func (cmd *CurrentProfileCmd) Run(ctx *context) error {
 	return nil
 }
 
-// SwitchProfileCmd provides a command to switch to a different profile.
+// ProfileSwitchCmd provides a command to switch to a different profile.
-type SwitchProfileCmd struct {
+type ProfileSwitchCmd struct {
 	Name string `arg:"" help:"Name of the profile to switch to." required:""`
 }
 
 // Run executes the command to switch to a different profile.
-func (cmd *SwitchProfileCmd) Run(ctx *context) error {
+func (cmd *ProfileSwitchCmd) Run(ctx *context) error {
 	profiles, err := ctx.Client.Config.GetProfileList()
 	if err != nil {
 		return err
@@ -74,13 +74,13 @@ func (cmd *SwitchProfileCmd) Run(ctx *context) error {
 	return nil
 }
 
-// CreateProfileCmd provides a command to create a new profile.
+// ProfileCreateCmd provides a command to create a new profile.
-type CreateProfileCmd struct {
+type ProfileCreateCmd struct {
 	Name string `arg:"" help:"Name of the profile to create." required:""`
 }
 
 // Run executes the command to create a new profile.
-func (cmd *CreateProfileCmd) Run(ctx *context) error {
+func (cmd *ProfileCreateCmd) Run(ctx *context) error {
 	profiles, err := ctx.Client.Config.GetProfileList()
 	if err != nil {
 		return err
@@ -100,13 +100,13 @@ func (cmd *CreateProfileCmd) Run(ctx *context) error {
 	return nil
 }
 
-// RemoveProfileCmd provides a command to remove an existing profile.
+// ProfileRemoveCmd provides a command to remove an existing profile.
-type RemoveProfileCmd struct {
+type ProfileRemoveCmd struct {
 	Name string `arg:"" help:"Name of the profile to delete." required:""`
 }
 
 // Run executes the command to remove an existing profile.
-func (cmd *RemoveProfileCmd) Run(ctx *context) error {
+func (cmd *ProfileRemoveCmd) Run(ctx *context) error {
 	profiles, err := ctx.Client.Config.GetProfileList()
 	if err != nil {
 		return err

record.go

@@ -44,24 +44,15 @@ type RecordToggleCmd struct{} // size = 0x0
 
 // Run executes the command to toggle recording.
 func (cmd *RecordToggleCmd) Run(ctx *context) error {
-	// Check if recording is in progress
+	status, err := ctx.Client.Record.ToggleRecord()
-	status, err := ctx.Client.Record.GetRecordStatus()
 	if err != nil {
 		return err
 	}
 
 	if status.OutputActive {
-		_, err = ctx.Client.Record.StopRecord()
-		if err != nil {
-			return err
-		}
-		fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
-	} else {
-		_, err = ctx.Client.Record.StartRecord()
-		if err != nil {
-			return err
-		}
 		fmt.Fprintln(ctx.Out, "Recording started successfully.")
+	} else {
+		fmt.Fprintln(ctx.Out, "Recording stopped successfully.")
 	}
 	return nil
 }

replaybuffer.go

@@ -8,6 +8,7 @@ import (
 type ReplayBufferCmd struct {
 	Start  ReplayBufferStartCmd  `help:"Start replay buffer."      cmd:"" aliases:"s"`
 	Stop   ReplayBufferStopCmd   `help:"Stop replay buffer."       cmd:"" aliases:"st"`
+	Toggle ReplayBufferToggleCmd `help:"Toggle replay buffer."     cmd:"" aliases:"tg"`
 	Status ReplayBufferStatusCmd `help:"Get replay buffer status." cmd:"" aliases:"ss"`
 	Save   ReplayBufferSaveCmd   `help:"Save replay buffer."       cmd:"" aliases:"sv"`
 }
@@ -30,6 +31,24 @@ func (cmd *ReplayBufferStopCmd) Run(ctx *context) error {
 	return err
 }
 
+// ReplayBufferToggleCmd toggles the replay buffer state.
+type ReplayBufferToggleCmd struct{} // size = 0x0
+
+// Run executes the command to toggle the replay buffer.
+func (cmd *ReplayBufferToggleCmd) Run(ctx *context) error {
+	status, err := ctx.Client.Outputs.ToggleReplayBuffer()
+	if err != nil {
+		return err
+	}
+
+	if status.OutputActive {
+		fmt.Fprintln(ctx.Out, "Replay buffer started successfully.")
+	} else {
+		fmt.Fprintln(ctx.Out, "Replay buffer stopped successfully.")
+	}
+	return nil
+}
+
 // ReplayBufferStatusCmd retrieves the status of the replay buffer.
 type ReplayBufferStatusCmd struct{} // size = 0x0
 

scenecollection.go

@@ -8,17 +8,17 @@ import (
 
 // SceneCollectionCmd provides commands to manage scene collections in OBS Studio.
 type SceneCollectionCmd struct {
-	List    ListSceneCollectionCmd    `help:"List scene collections."       cmd:"" aliases:"ls"`
+	List    SceneCollectionListCmd    `help:"List scene collections."       cmd:"" aliases:"ls"`
-	Current CurrentSceneCollectionCmd `help:"Get current scene collection." cmd:"" aliases:"c"`
+	Current SceneCollectionCurrentCmd `help:"Get current scene collection." cmd:"" aliases:"c"`
-	Switch  SwitchSceneCollectionCmd  `help:"Switch scene collection."      cmd:"" aliases:"sw"`
+	Switch  SceneCollectionSwitchCmd  `help:"Switch scene collection."      cmd:"" aliases:"sw"`
-	Create  CreateSceneCollectionCmd  `help:"Create scene collection."      cmd:"" aliases:"new"`
+	Create  SceneCollectionCreateCmd  `help:"Create scene collection."      cmd:"" aliases:"new"`
 }
 
-// ListSceneCollectionCmd provides a command to list all scene collections.
+// SceneCollectionListCmd provides a command to list all scene collections.
-type ListSceneCollectionCmd struct{} // size = 0x0
+type SceneCollectionListCmd struct{} // size = 0x0
 
 // Run executes the command to list all scene collections.
-func (cmd *ListSceneCollectionCmd) Run(ctx *context) error {
+func (cmd *SceneCollectionListCmd) Run(ctx *context) error {
 	collections, err := ctx.Client.Config.GetSceneCollectionList()
 	if err != nil {
 		return fmt.Errorf("failed to get scene collection list: %w", err)
@@ -31,11 +31,11 @@ func (cmd *ListSceneCollectionCmd) Run(ctx *context) error {
 	return nil
 }
 
-// CurrentSceneCollectionCmd provides a command to get the current scene collection.
+// SceneCollectionCurrentCmd provides a command to get the current scene collection.
-type CurrentSceneCollectionCmd struct{} // size = 0x0
+type SceneCollectionCurrentCmd struct{} // size = 0x0
 
 // Run executes the command to get the current scene collection.
-func (cmd *CurrentSceneCollectionCmd) Run(ctx *context) error {
+func (cmd *SceneCollectionCurrentCmd) Run(ctx *context) error {
 	collections, err := ctx.Client.Config.GetSceneCollectionList()
 	if err != nil {
 		return fmt.Errorf("failed to get scene collection list: %w", err)
@@ -45,13 +45,13 @@ func (cmd *CurrentSceneCollectionCmd) Run(ctx *context) error {
 	return nil
 }
 
-// SwitchSceneCollectionCmd provides a command to switch to a different scene collection.
+// SceneCollectionSwitchCmd provides a command to switch to a different scene collection.
-type SwitchSceneCollectionCmd struct {
+type SceneCollectionSwitchCmd struct {
 	Name string `arg:"" help:"Name of the scene collection to switch to." required:""`
 }
 
 // Run executes the command to switch to a different scene collection.
-func (cmd *SwitchSceneCollectionCmd) Run(ctx *context) error {
+func (cmd *SceneCollectionSwitchCmd) Run(ctx *context) error {
 	collections, err := ctx.Client.Config.GetSceneCollectionList()
 	if err != nil {
 		return err
@@ -74,13 +74,13 @@ func (cmd *SwitchSceneCollectionCmd) Run(ctx *context) error {
 	return nil
 }
 
-// CreateSceneCollectionCmd provides a command to create a new scene collection.
+// SceneCollectionCreateCmd provides a command to create a new scene collection.
-type CreateSceneCollectionCmd struct {
+type SceneCollectionCreateCmd struct {
 	Name string `arg:"" help:"Name of the scene collection to create." required:""`
 }
 
 // Run executes the command to create a new scene collection.
-func (cmd *CreateSceneCollectionCmd) Run(ctx *context) error {
+func (cmd *SceneCollectionCreateCmd) Run(ctx *context) error {
 	_, err := ctx.Client.Config.CreateSceneCollection(
 		config.NewCreateSceneCollectionParams().WithSceneCollectionName(cmd.Name),
 	)

stream.go

@@ -41,19 +41,15 @@ type StreamToggleCmd struct{} // size = 0x0
 
 // Run executes the command to toggle streaming.
 func (cmd *StreamToggleCmd) Run(ctx *context) error {
-	status, err := ctx.Client.Stream.GetStreamStatus()
+	status, err := ctx.Client.Stream.ToggleStream()
 	if err != nil {
 		return err
 	}
+
 	if status.OutputActive {
-		_, err = ctx.Client.Stream.StopStream()
+		fmt.Fprintln(ctx.Out, "Streaming started successfully.")
-		fmt.Fprintf(ctx.Out, "Stopping stream...\n")
 	} else {
-		_, err = ctx.Client.Stream.StartStream()
+		fmt.Fprintln(ctx.Out, "Streaming stopped successfully.")
-		fmt.Fprintf(ctx.Out, "Starting stream...\n")
-	}
-	if err != nil {
-		return err
 	}
 	return nil
 }

virtualcam.go

@@ -6,17 +6,17 @@ import (
 
 // VirtualCamCmd handles the virtual camera commands.
 type VirtualCamCmd struct {
-	Start  StartVirtualCamCmd  `help:"Start virtual camera."      cmd:"" aliases:"s"`
+	Start  VirtualCamStartCmd  `help:"Start virtual camera."      cmd:"" aliases:"s"`
-	Stop   StopVirtualCamCmd   `help:"Stop virtual camera."       cmd:"" aliases:"st"`
+	Stop   VirtualCamStopCmd   `help:"Stop virtual camera."       cmd:"" aliases:"st"`
-	Toggle ToggleVirtualCamCmd `help:"Toggle virtual camera."     cmd:"" aliases:"tg"`
+	Toggle VirtualCamToggleCmd `help:"Toggle virtual camera."     cmd:"" aliases:"tg"`
-	Status StatusVirtualCamCmd `help:"Get virtual camera status." cmd:"" aliases:"ss"`
+	Status VirtualCamStatusCmd `help:"Get virtual camera status." cmd:"" aliases:"ss"`
 }
 
-// StartVirtualCamCmd starts the virtual camera.
+// VirtualCamStartCmd starts the virtual camera.
-type StartVirtualCamCmd struct{} // size = 0x0
+type VirtualCamStartCmd struct{} // size = 0x0
 
 // Run executes the command to start the virtual camera.
-func (c *StartVirtualCamCmd) Run(ctx *context) error {
+func (c *VirtualCamStartCmd) Run(ctx *context) error {
 	_, err := ctx.Client.Outputs.StartVirtualCam()
 	if err != nil {
 		return fmt.Errorf("failed to start virtual camera: %w", err)
@@ -25,11 +25,11 @@ func (c *StartVirtualCamCmd) Run(ctx *context) error {
 	return nil
 }
 
-// StopVirtualCamCmd stops the virtual camera.
+// VirtualCamStopCmd stops the virtual camera.
-type StopVirtualCamCmd struct{} // size = 0x0
+type VirtualCamStopCmd struct{} // size = 0x0
 
 // Run executes the command to stop the virtual camera.
-func (c *StopVirtualCamCmd) Run(ctx *context) error {
+func (c *VirtualCamStopCmd) Run(ctx *context) error {
 	_, err := ctx.Client.Outputs.StopVirtualCam()
 	if err != nil {
 		return fmt.Errorf("failed to stop virtual camera: %w", err)
@@ -38,11 +38,11 @@ func (c *StopVirtualCamCmd) Run(ctx *context) error {
 	return nil
 }
 
-// ToggleVirtualCamCmd toggles the virtual camera.
+// VirtualCamToggleCmd toggles the virtual camera.
-type ToggleVirtualCamCmd struct{} // size = 0x0
+type VirtualCamToggleCmd struct{} // size = 0x0
 
 // Run executes the command to toggle the virtual camera.
-func (c *ToggleVirtualCamCmd) Run(ctx *context) error {
+func (c *VirtualCamToggleCmd) Run(ctx *context) error {
 	_, err := ctx.Client.Outputs.ToggleVirtualCam()
 	if err != nil {
 		return fmt.Errorf("failed to toggle virtual camera: %w", err)
@@ -50,11 +50,11 @@ func (c *ToggleVirtualCamCmd) Run(ctx *context) error {
 	return nil
 }
 
-// StatusVirtualCamCmd retrieves the status of the virtual camera.
+// VirtualCamStatusCmd retrieves the status of the virtual camera.
-type StatusVirtualCamCmd struct{} // size = 0x0
+type VirtualCamStatusCmd struct{} // size = 0x0
 
 // Run executes the command to get the status of the virtual camera.
-func (c *StatusVirtualCamCmd) Run(ctx *context) error {
+func (c *VirtualCamStatusCmd) Run(ctx *context) error {
 	status, err := ctx.Client.Outputs.GetVirtualCamStatus()
 	if err != nil {
 		return fmt.Errorf("failed to get virtual camera status: %w", err)