From 5dd3057371fe87434f2da54f68cdcc3dc5fd754a Mon Sep 17 00:00:00 2001 From: Salim Afiune Maya Date: Thu, 23 Apr 2020 15:40:43 -0600 Subject: [PATCH] chore(cli): update usage of commands Signed-off-by: Salim Afiune Maya --- cli/cmd/api.go | 2 +- cli/cmd/configure.go | 2 +- cli/cmd/event.go | 5 +++-- cli/cmd/integration.go | 12 ++++++------ 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/cli/cmd/api.go b/cli/cmd/api.go index 255953303..91ca4cac2 100644 --- a/cli/cmd/api.go +++ b/cli/cmd/api.go @@ -39,7 +39,7 @@ var ( // apiCmd represents the api command apiCmd = &cobra.Command{ Use: "api ", - Short: "Helper to call Lacework's RestfulAPI", + Short: "helper to call Lacework's RestfulAPI", Long: `Use this command as a helper to call any available Lacework API endpoint. For example, to list all integrations configured in your account run: diff --git a/cli/cmd/configure.go b/cli/cmd/configure.go index 61b33271e..6d89bbe63 100644 --- a/cli/cmd/configure.go +++ b/cli/cmd/configure.go @@ -57,7 +57,7 @@ var ( // configureCmd represents the configure command configureCmd = &cobra.Command{ Use: "configure", - Short: "Configure the Lacework CLI", + Short: "configure the Lacework CLI", Args: cobra.NoArgs, Long: ` Configure settings that the Lacework CLI uses to interact with the Lacework diff --git a/cli/cmd/event.go b/cli/cmd/event.go index f90d3891d..578064a18 100644 --- a/cli/cmd/event.go +++ b/cli/cmd/event.go @@ -33,13 +33,14 @@ var ( // eventCmd represents the event command eventCmd = &cobra.Command{ Use: "event", - Short: "Inspect Lacework events", + Short: "inspect Lacework events", + Long: `Inspect events reported by the Lacework platform`, } // eventListCmd represents the list sub-command inside the event command eventListCmd = &cobra.Command{ Use: "list", - Short: "List all events from a date range (default last 7 days)", + Short: "list all events from a date range (default last 7 days)", Long: `List all events from a data range, by default it displays the last 7 days, but you can specify a different time range.`, Args: cobra.NoArgs, diff --git a/cli/cmd/integration.go b/cli/cmd/integration.go index 0323c1a83..e1865cf1a 100644 --- a/cli/cmd/integration.go +++ b/cli/cmd/integration.go @@ -33,14 +33,14 @@ var ( integrationCmd = &cobra.Command{ Use: "integration", Aliases: []string{"int"}, - Short: "Manage external integrations", - Long: ``, + Short: "manage external integrations", + Long: `Manage external integrations with the Lacework platform`, } // integrationListCmd represents the list sub-command inside the integration command integrationListCmd = &cobra.Command{ Use: "list", - Short: "List all available external integrations", + Short: "list all available external integrations", Args: cobra.NoArgs, RunE: func(_ *cobra.Command, _ []string) error { lacework, err := api.NewClient(cli.Account, @@ -73,7 +73,7 @@ var ( integrationCreateCmd = &cobra.Command{ Use: "create", Hidden: true, - Short: "Create an external integrations", + Short: "create an external integrations", Args: cobra.NoArgs, RunE: func(_ *cobra.Command, _ []string) error { return nil @@ -84,7 +84,7 @@ var ( integrationUpdateCmd = &cobra.Command{ Use: "update", Hidden: true, - Short: "Update an external integrations", + Short: "update an external integrations", Args: cobra.NoArgs, RunE: func(_ *cobra.Command, _ []string) error { return nil @@ -95,7 +95,7 @@ var ( integrationDeleteCmd = &cobra.Command{ Use: "delete", Hidden: true, - Short: "Delete an external integrations", + Short: "delete an external integrations", Args: cobra.NoArgs, RunE: func(_ *cobra.Command, _ []string) error { return nil