Improve help command layout

gtsiolis · gtsiolis · commit 597f760a49a2 · 2026-02-25T22:59:57.000+02:00
diff --git a/cmd/root.go b/cmd/root.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/localstack/lstk/internal/api"
 	"github.com/localstack/lstk/internal/config"
@@ -38,6 +39,33 @@ var rootCmd = &cobra.Command{
 func init() {
 	rootCmd.Version = version.Version()
 	rootCmd.SetVersionTemplate(versionLine() + "\n")
+
+	rootCmd.InitDefaultHelpFlag()
+	rootCmd.Flags().Lookup("help").Usage = "Show help"
+
+	rootCmd.InitDefaultVersionFlag()
+	rootCmd.Flags().Lookup("version").Usage = "Show version"
+
+	usageTemplate := rootCmd.UsageTemplate()
+	usageTemplate = strings.Replace(usageTemplate, "Available Commands:", "Commands:", 1)
+	usageTemplate = strings.Replace(usageTemplate, "Flags:", "Options:", 1)
+	usageTemplate = strings.Replace(
+		usageTemplate,
+		`Usage:{{if .Runnable}}
+  {{.UseLine}}{{end}}{{if .HasAvailableSubCommands}}
+  {{.CommandPath}} [command]{{end}}`,
+		`Usage: {{if eq .CommandPath "lstk"}}lstk [options] [command]{{else}}{{.UseLine}}{{end}}{{if eq .CommandPath "lstk"}}
+
+LSTK - LocalStack command-line interace{{end}}`,
+		1,
+	)
+	usageTemplate = strings.ReplaceAll(usageTemplate, `Use "{{.CommandPath}} [command] --help" for more information about a command.`, "")
+	usageTemplate = strings.TrimRight(usageTemplate, "\n")
+	rootCmd.SetUsageTemplate(usageTemplate)
+
+	rootCmd.SetHelpTemplate(`{{if eq .CommandPath "lstk"}}{{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}{{else}}{{with (or .Long .Short)}}{{. | trimTrailingWhitespaces}}
+
+{{end}}{{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}{{end}}`)
 	rootCmd.AddCommand(startCmd)
 }
 
diff --git a/cmd/version.go b/cmd/version.go
@@ -9,7 +9,7 @@ import (
 
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "Print the lstk version",
+	Short: "Show version",
 	Long:  "Print version information for the lstk binary.",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		_, err := fmt.Fprintln(cmd.OutOrStdout(), versionLine())
