Skip to content

Commit

Permalink
Wrap help message, add single-letter aliases
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Dec 3, 2020
1 parent 1503d74 commit 64080fa
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 8 deletions.
10 changes: 6 additions & 4 deletions cmd/apps/openfaas_ingress_app.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,12 @@ type inputData struct {
//MakeInstallOpenFaaSIngess will install a clusterissuer and request a cert from certmanager for the domain you specify
func MakeInstallOpenFaaSIngress() *cobra.Command {
var openfaasIngress = &cobra.Command{
Use: "openfaas-ingress",
Short: "Install openfaas ingress with TLS",
Long: `Install openfaas ingress. Requires cert-manager 0.11.0 or higher installation in the cluster. Please set --domain to your custom domain and set --email to your email - this email is used by letsencrypt for domain expiry etc.`,
Example: ` arkade install openfaas-ingress --domain openfaas.example.com --email [email protected]`,
Use: "openfaas-ingress",
Short: "Install openfaas ingress with TLS",
Long: `Install openfaas ingress. Requires cert-manager 1.0.0+ the cluster.`,
Example: ` arkade install openfaas-ingress \
--domain openfaas.example.com \
--email [email protected]`,
SilenceUsage: true,
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ and provides a fast and easy alternative to a package manager.`,
# Get a complete list of CLIs to download:
arkade get --help`,
SilenceUsage: true,
Aliases: []string{"g"},
Aliases: []string{"g", "d", "download"},
ValidArgs: validToolOptions,
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ func MakeInfo() *cobra.Command {
Use: "info",
Short: "Find info about a Kubernetes app",
Long: "Find info about how to use the installed Kubernetes app",
Aliases: []string{"i"},
Aliases: []string{"f"},
Example: ` arkade info [APP]
arkade info openfaas
arkade info inlets-operator
Expand Down
5 changes: 3 additions & 2 deletions cmd/install.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ type ArkadeApp struct {

func MakeInstall() *cobra.Command {
var command = &cobra.Command{
Use: "install",
Short: "Install Kubernetes apps from helm charts or YAML files",
Use: "install",
Short: "Install Kubernetes apps from helm charts or YAML files",
Aliases: []string{"i"},
Long: `Install Kubernetes apps from helm charts or YAML files using the "install"
command.
Expand Down
1 change: 1 addition & 0 deletions cmd/update.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ func MakeUpdate() *cobra.Command {
Use: "update",
Short: "Print update instructions",
Example: ` arkade update`,
Aliases: []string{"u"},
SilenceUsage: false,
}
command.Run = func(cmd *cobra.Command, args []string) {
Expand Down
1 change: 1 addition & 0 deletions cmd/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ func MakeVersion() *cobra.Command {
Use: "version",
Short: "Print the version",
Example: ` arkade version`,
Aliases: []string{"v"},
SilenceUsage: false,
}
command.Run = func(cmd *cobra.Command, args []string) {
Expand Down

0 comments on commit 64080fa

Please sign in to comment.