STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document exit code behavior

Browse source
This commit is contained in:
Stausssi 2024-07-22 20:36:22 +02:00
parent 0a3a12839d
commit e7606363fb
No known key found for this signature in database
GPG key ID: 5B3039E3F18332F0
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
pkg/cmd/auth/status/status.go
View file

@ -145,8 +145,11 @@ func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Co
Long: heredoc.Docf(`
Display active account and authentication state on each known GitHub host.
For each host, the authentication state of each known account is tested and any issues are included in
the output. Each host section will indicate the active account, which will be used when targeting that host.
For each host, the authentication state of each known account is tested and any issues are included in the output.
Each host section will indicate the active account, which will be used when targeting that host.
If an account on any host (or only the one given via %[1]s--hostname%[1]s) has authentication issues,
the command will exit with 1 and output to stderr.
To change the active account for a host, see %[1]sgh auth switch%[1]s.
`, "`"),
RunE: func(cmd *cobra.Command, args []string) error {
@ -158,7 +161,7 @@ func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Co
},
}
cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "Check a specific hostname's auth status")
cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "Check only a specific hostname's auth status")
cmd.Flags().BoolVarP(&opts.ShowToken, "show-token", "t", false, "Display the auth token")
return cmd