add task to view man page

move man tasks into Taskfile.man.yaml
reword
2026-04-20 16:13:40 +00:00 · 2025-04-29 18:35:58 +01:00 · 2025-04-29 16:59:08 +01:00 · 2025-04-29 16:54:51 +01:00 · 2025-04-29 16:50:45 +01:00 · 2025-04-29 15:19:16 +01:00
8 changed files with 46 additions and 1 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -27,4 +27,5 @@ go.work
 # End of gignore: github.com/onyx-and-iris/gignore

 .envrc
-*_test.go
+*_test.go
+gobs-cli.1
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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.2.0] - 2025-04-27
+
+### Added
+
+-   sceneitem transform, see *transform* under [SceneItemCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#sceneitemcmd)
+
 # [0.1.0] - 2025-04-24

 ### Added
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@ A command line interface for OBS Websocket v5

 For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)

+## Installation
+
+```console
+go install github.com/onyx-and-iris/gobs-cli@latest
+```
+
 ## Configuration

 #### Flags
--- a/Taskfile.man.yaml
+++ b/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
--- a/Taskfile.yaml
+++ b/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}}'
--- a/go.mod
+++ b/go.mod
@@ -4,6 +4,7 @@ go 1.24.0

 require (
 	github.com/alecthomas/kong v1.10.0
+	github.com/alecthomas/mango-kong v0.1.0
 	github.com/andreykaipov/goobs v1.5.6
 )

@@ -13,5 +14,7 @@ require (
 	github.com/hashicorp/logutils v1.0.0 // 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
+	github.com/muesli/roff v0.1.0 // indirect
 	github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect
 )
--- a/go.sum
+++ b/go.sum
@@ -2,6 +2,8 @@ github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8v
 github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
 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.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=
@@ -20,6 +22,10 @@ github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyua
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/mmcloughlin/profile v0.1.1 h1:jhDmAqPyebOsVDOCICJoINoLb/AnLBaUw58nFzxWS2w=
 github.com/mmcloughlin/profile v0.1.1/go.mod h1:IhHD7q1ooxgwTgjxQYkACGA77oFTDdFVejUS1/tS/qU=
+github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab h1:m7QFONkzLK0fVXCjwX5tANcnj1yXxTnYQtnfJiY3tcA=
+github.com/muesli/mango v0.1.1-0.20220205060214-77e2058169ab/go.mod h1:5XFpbC8jY5UUv89YQciiXNlbi+iJgt29VDC5xbzrLL4=
+github.com/muesli/roff v0.1.0 h1:YD0lalCotmYuF5HhZliKWlIx7IEhiXeSfq7hNjFqGF8=
+github.com/muesli/roff v0.1.0/go.mod h1:pjAHQM9hdUUwm/krAfrLGgJkXJ+YuhtsfZ42kieB2Ig=
 github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ=
 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=
--- a/main.go
+++ b/main.go
@@ -10,6 +10,7 @@ import (
 	"time"

 	"github.com/alecthomas/kong"
+	mangokong "github.com/alecthomas/mango-kong"
 	"github.com/andreykaipov/goobs"
 )

@@ -26,6 +27,8 @@ type ObsConfig struct {
 type cli struct {
 	ObsConfig `embed:"" help:"OBS WebSocket configuration."`

+	Man mangokong.ManFlag `help:"Print man page."`
+
 	Version         VersionCmd         `help:"Show version."             cmd:"" aliases:"v"`
 	Scene           SceneCmd           `help:"Manage scenes."            cmd:"" aliases:"sc"`
 	Sceneitem       SceneItemCmd       `help:"Manage scene items."       cmd:"" aliases:"si"`
Author	SHA1	Message	Date
onyx-and-iris	8cf969c906	add task to view man page move man tasks into Taskfile.man.yaml	2025-04-29 18:35:58 +01:00
onyx-and-iris	3540c60c4b	reword	2025-04-29 16:59:08 +01:00
onyx-and-iris	b2c5980b4a	use task var	2025-04-29 16:54:51 +01:00
onyx-and-iris	da1ef9f993	upd task name + outfile name	2025-04-29 16:50:45 +01:00
onyx-and-iris	0a2c622645	add --man flag for generating manfile	2025-04-29 15:19:16 +01:00
onyx-and-iris	cb973c09f5	add installation section to readme	2025-04-27 14:14:42 +01:00
onyx-and-iris	4fa32bfb42	upd changelog	2025-04-27 13:30:44 +01:00