diff --git a/README.md b/README.md index 05270b5..4458063 100644 --- a/README.md +++ b/README.md @@ -9,27 +9,27 @@ Amazon Elastic Container Service (ECS). command: ``` -$ ./anchore-ecs-inventory --help -Anchore ECS Inventory can poll Amazon ECS (Elastic Container Service) APIs to tell Anchore which Images are currently in-use +$ anchore-ecs-inventory can poll Amazon ECS (Elastic Container Service) APIs to tell Anchore which Images are currently in-use Usage: -anchore-ecs-inventory [flags] -anchore-ecs-inventory [command] + anchore-ecs-inventory [flags] + anchore-ecs-inventory [command] Available Commands: -completion Generate Completion script -help Help about any command -version show the version + completion Generate Completion script + help Help about any command + version show the version Flags: --c, --config string application config file --h, --help help for anchore-ecs-inventory --p, --polling-interval-seconds string This specifies the polling interval of the ECS API in seconds (default "300") --q, --quiet Suppresses inventory report output to stdout --r, --region string If set overrides the AWS_REGION environment variable/region specified in the config file --v, --verbose count increase verbosity (-v = info, -vv = debug) - -Use "anchore-ecs-inventory [command] --help" for more information about a command + -c, --config string application config file + -d, --dry-run do not report inventory to Anchore + -h, --help help for anchore-ecs-inventory + -p, --polling-interval-seconds string this specifies the polling interval of the ECS API in seconds (default "300") + -q, --quiet suppresses inventory report output to stdout + -r, --region string if set overrides the AWS_REGION environment variable/region specified in anchore-ecs-inventory config + -v, --verbose count increase verbosity (-v = info, -vv = debug) + +Use "anchore-ecs-inventory [command] --help" for more information about a command. ``` ## Configuration diff --git a/cmd/root.go b/cmd/root.go index 89c797c..721108d 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -57,7 +57,7 @@ var rootCmd = &cobra.Command{ func init() { opt := "polling-interval-seconds" rootCmd.Flags(). - StringP(opt, "p", strconv.Itoa(config.DefaultConfigValues.PollingIntervalSeconds), "This specifies the polling interval of the ECS API in seconds") + StringP(opt, "p", strconv.Itoa(config.DefaultConfigValues.PollingIntervalSeconds), "this specifies the polling interval of the ECS API in seconds") if err := viper.BindPFlag(opt, rootCmd.Flags().Lookup(opt)); err != nil { fmt.Printf("unable to bind flag '%s': %+v", opt, err) os.Exit(1) @@ -65,7 +65,7 @@ func init() { opt = "region" rootCmd.Flags(). - StringP(opt, "r", config.DefaultConfigValues.Region, "If set overrides the AWS_REGION environment variable/region specified in anchore-ecs-inventory config") + StringP(opt, "r", config.DefaultConfigValues.Region, "if set overrides the AWS_REGION environment variable/region specified in anchore-ecs-inventory config") if err := viper.BindPFlag(opt, rootCmd.Flags().Lookup(opt)); err != nil { fmt.Printf("unable to bind flag '%s': %+v", opt, err) os.Exit(1) @@ -73,7 +73,7 @@ func init() { opt = "quiet" rootCmd.Flags(). - BoolP(opt, "q", config.DefaultConfigValues.Quiet, "Suppresses inventory report output to stdout") + BoolP(opt, "q", config.DefaultConfigValues.Quiet, "suppresses inventory report output to stdout") if err := viper.BindPFlag(opt, rootCmd.Flags().Lookup(opt)); err != nil { fmt.Printf("unable to bind flag '%s': %+v", opt, err) os.Exit(1) @@ -81,7 +81,7 @@ func init() { opt = "dry-run" rootCmd.Flags(). - BoolP(opt, "d", config.DefaultConfigValues.DryRun, "Do not report inventory to Anchore") + BoolP(opt, "d", config.DefaultConfigValues.DryRun, "do not report inventory to Anchore") if err := viper.BindPFlag(opt, rootCmd.Flags().Lookup(opt)); err != nil { fmt.Printf("unable to bind flag '%s': %+v", opt, err) os.Exit(1)