add generate-readme task

add generate_help.go

update pre-commit hook

.pre-commit-config.yaml

@@ -3,6 +3,6 @@ repos:
     hooks:
       - id: update-readme
         name: update-readme
-        entry: python update_readme.py
-        language: python
+        entry: go generate ./tools
+        language: system
         pass_filenames: false

README.md

@@ -60,8 +60,8 @@ export X32_CLI_LOGLEVEL=warn
 
 For each command/subcommand in the tree there exists a `--help` flag, use it to print usage information.
 
-- [xair-cli](./xair-help.md)
-- [x32-cli](./x32-help.md)
+- [xair-cli](./tools/xair-help.md)
+- [x32-cli](./tools/x32-help.md)
 
 ### Examples
 

Taskfile.yml

@@ -62,3 +62,8 @@ tasks:
     desc: Clean the build artifacts
     cmds:
       - '{{.SHELL}} rm -r {{.BIN_DIR}}'
+
+  update-readme:
+    desc: Update the README.md file with the latest help output from the commands
+    cmds:
+      - go generate ./tools

tools/generate_help.go

@@ -0,0 +1,31 @@
+//go:generate go run generate_help.go
+
+package main
+
+import (
+	"os"
+	"os/exec"
+)
+
+func main() {
+	clis := []struct {
+		cmd string
+		out string
+	}{
+		{"../cmd/xair-cli/", "xair-help.md"},
+		{"../cmd/x32-cli/", "x32-help.md"},
+	}
+
+	for _, cli := range clis {
+		helpCmd := exec.Command("go", "run", cli.cmd, "--help")
+		out, err := helpCmd.Output()
+		if err != nil {
+			panic(err)
+		}
+
+		// Wrap output in markdown console code block
+		wrapped := append([]byte("```console\n"), out...)
+		wrapped = append(wrapped, []byte("\n```\n")...)
+		os.WriteFile(cli.out, wrapped, 0o644)
+	}
+}

tools/x32-help.md

@@ -195,4 +195,5 @@ DCA
   dca <index> name    Get or set the name of the DCA group.
 
 Run "x32-cli <command> --help" for more information on a command.
+
 ```

tools/xair-help.md

@@ -127,4 +127,5 @@ DCA
   dca <index> name    Get or set the name of the DCA group.
 
 Run "xair-cli <command> --help" for more information on a command.
+
 ```