From 92b9b8b6b28df6218fb650a2b0daa1da4d65e27f Mon Sep 17 00:00:00 2001 From: Christopher Crone Date: Tue, 21 Aug 2018 17:29:10 +0200 Subject: [PATCH] Capitalise help outputs Signed-off-by: Christopher Crone --- README.md | 25 ++++++++++++++++--------- cmd/docker-app/deploy.go | 8 ++++---- cmd/docker-app/push.go | 4 ++-- cmd/docker-app/root.go | 5 +++-- cmd/docker-app/save.go | 4 ++-- 5 files changed, 27 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3b3b060ef..777798c87 100644 --- a/README.md +++ b/README.md @@ -235,12 +235,23 @@ We have lots of ideas for making Compose-based applications easier to share and ``` $ docker-app -Build and deploy Docker applications. -Usage: - docker-app [command] +Usage: docker-app [OPTIONS] COMMAND -Available Commands: +Docker Application Packages + +Options: + -D, --debug Enable debug mode + -H, --host list Daemon socket(s) to connect to + -l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info") + --tls Use TLS; implied by --tlsverify + --tlscacert string Trust certs signed only by this CA (default "/Users/chris/.docker/ca.pem") + --tlscert string Path to TLS certificate file (default "/Users/chris/.docker/cert.pem") + --tlskey string Path to TLS key file (default "/Users/chris/.docker/key.pem") + --tlsverify Use TLS and verify the remote + -v, --version Print version information + +Commands: completion Generates bash completion scripts deploy Deploy or update an application fork Create a fork of an existing application to be modified @@ -256,9 +267,5 @@ Available Commands: validate Checks the rendered application is syntactically correct version Print version information -Flags: - --debug Enable debug mode - -h, --help help for docker-app - -Use "docker-app [command] --help" for more information about a command. +Run 'docker-app COMMAND --help' for more information on a command. ``` diff --git a/cmd/docker-app/deploy.go b/cmd/docker-app/deploy.go index 385239e0e..ce3f02259 100644 --- a/cmd/docker-app/deploy.go +++ b/cmd/docker-app/deploy.go @@ -43,10 +43,10 @@ func deployCmd(dockerCli command.Cli) *cobra.Command { cmd.Flags().StringArrayVarP(&opts.deploySettingsFiles, "settings-files", "f", []string{}, "Override settings files") cmd.Flags().StringArrayVarP(&opts.deployEnv, "set", "s", []string{}, "Override settings values") cmd.Flags().StringVarP(&opts.deployOrchestrator, "orchestrator", "o", "swarm", "Orchestrator to deploy on (swarm, kubernetes)") - cmd.Flags().StringVarP(&opts.deployKubeConfig, "kubeconfig", "k", "", "kubeconfig file to use") - cmd.Flags().StringVarP(&opts.deployNamespace, "namespace", "n", "default", "namespace to deploy into") - cmd.Flags().StringVarP(&opts.deployStackName, "name", "d", "", "stack name (default: app name)") - cmd.Flags().BoolVarP(&opts.deploySendRegistryAuth, "with-registry-auth", "", false, "sends registry auth") + cmd.Flags().StringVarP(&opts.deployKubeConfig, "kubeconfig", "k", "", "Kubernetes config file to use") + cmd.Flags().StringVarP(&opts.deployNamespace, "namespace", "n", "default", "Kubernetes namespace to deploy into") + cmd.Flags().StringVarP(&opts.deployStackName, "name", "d", "", "Stack name (default: app name)") + cmd.Flags().BoolVarP(&opts.deploySendRegistryAuth, "with-registry-auth", "", false, "Sends registry auth") if internal.Experimental == "on" { cmd.Flags().StringArrayVarP(&opts.deployComposeFiles, "compose-files", "c", []string{}, "Override Compose files") } diff --git a/cmd/docker-app/push.go b/cmd/docker-app/push.go index 91b67649e..6eedb1a87 100644 --- a/cmd/docker-app/push.go +++ b/cmd/docker-app/push.go @@ -26,7 +26,7 @@ func pushCmd() *cobra.Command { return packager.Push(app, opts.namespace, opts.tag) }, } - cmd.Flags().StringVar(&opts.namespace, "namespace", "", "namespace to use (default: namespace in metadata)") - cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "tag to use (default: version in metadata)") + cmd.Flags().StringVar(&opts.namespace, "namespace", "", "Namespace to use (default: namespace in metadata)") + cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "Tag to use (default: version in metadata)") return cmd } diff --git a/cmd/docker-app/root.go b/cmd/docker-app/root.go index 9a41fd0bc..58f809b37 100644 --- a/cmd/docker-app/root.go +++ b/cmd/docker-app/root.go @@ -21,8 +21,8 @@ func newRootCmd(dockerCli *command.DockerCli) *cobra.Command { cmd := &cobra.Command{ Use: "docker-app", - Short: "Docker App Packages", - Long: `Build and deploy Docker applications.`, + Short: "Docker Application Packages", + Long: `Build and deploy Docker Application Packages.`, SilenceUsage: true, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { opts.Common.SetDefaultOptions(flags) @@ -33,6 +33,7 @@ func newRootCmd(dockerCli *command.DockerCli) *cobra.Command { } cli.SetupRootCommand(cmd) flags = cmd.Flags() + flags.BoolP("version", "v", false, "Print version information") opts.Common.InstallFlags(flags) cmd.SetVersionTemplate("docker-app version {{.Version}}\n") addCommands(cmd, dockerCli) diff --git a/cmd/docker-app/save.go b/cmd/docker-app/save.go index 87af5fc89..aad7d6b7e 100644 --- a/cmd/docker-app/save.go +++ b/cmd/docker-app/save.go @@ -33,7 +33,7 @@ func saveCmd(dockerCli command.Cli) *cobra.Command { return err }, } - cmd.Flags().StringVar(&opts.namespace, "namespace", "", "namespace to use (default: namespace in metadata)") - cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "tag to use (default: version in metadata)") + cmd.Flags().StringVar(&opts.namespace, "namespace", "", "Namespace to use (default: namespace in metadata)") + cmd.Flags().StringVarP(&opts.tag, "tag", "t", "", "Tag to use (default: version in metadata)") return cmd }