From 85c893fd816394c96e22cb265b6a06c83e416fe7 Mon Sep 17 00:00:00 2001
From: charitybell <128868596+charitybell@users.noreply.github.com>
Date: Tue, 25 Apr 2023 14:48:43 -0700
Subject: [PATCH] Add an explicit help flag that exits with 0 (#3654)

`stash --help` exits with a non-zero exit code. Because `stash --help`
is a legitimate invocation, it should return an exit code of zero.
Adding an explicit help flag allows for exiting with a successful exit
code.
---
 internal/manager/config/init.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/internal/manager/config/init.go b/internal/manager/config/init.go
index f512999a6..37a191436 100644
--- a/internal/manager/config/init.go
+++ b/internal/manager/config/init.go
@@ -24,6 +24,7 @@ type flagStruct struct {
 	configFilePath string
 	cpuProfilePath string
 	nobrowser      bool
+	helpFlag       bool
 }
 
 func GetInstance() *Instance {
@@ -40,6 +41,12 @@ func Initialize() (*Instance, error) {
 	var err error
 	initOnce.Do(func() {
 		flags := initFlags()
+
+		if flags.helpFlag {
+			pflag.Usage()
+			os.Exit(0)
+		}
+
 		overrides := makeOverrideConfig()
 
 		_ = GetInstance()
@@ -126,6 +133,7 @@ func initFlags() flagStruct {
 	pflag.StringVarP(&flags.configFilePath, "config", "c", "", "config file to use")
 	pflag.StringVar(&flags.cpuProfilePath, "cpuprofile", "", "write cpu profile to file")
 	pflag.BoolVar(&flags.nobrowser, "nobrowser", false, "Don't open a browser window after launch")
+	pflag.BoolVarP(&flags.helpFlag, "help", "h", false, "show this help text and exit")
 
 	pflag.Parse()