chore: show component command in lacework --help (#1660)

* chore: show component command in lacework --help

* chore: gitlint

Author: PengyuanZhao

.github/workflows/commit-lint.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Install gitlint
         shell: bash
         run: |
-          python -m pip install gitlint --break-system-packages
+          python -m pip install gitlint
 
       - name: Run gitlint
         shell: bash

cli/cmd/component.go

@@ -41,7 +41,6 @@ var (
 	// componentsCmd represents the components command
 	componentsCmd = &cobra.Command{
 		Use:     "component",
-		Hidden:  true,
 		Aliases: []string{"components"},
 		Short:   "Manage components",
 		Long:    `Manage components to extend your experience with the Lacework platform`,

integration/test_resources/help/component

@@ -7,10 +7,11 @@ Aliases:
   component, components
 
 Available Commands:
-  install     install a new component
-  list        list all components
-  uninstall   uninstall an existing component
-  update      update an existing component
+  install     Install a new component
+  list        List all components
+  show        Show details about a component
+  uninstall   Uninstall an existing component
+  update      Update an existing component
 
 Flags:
   -h, --help   help for component

integration/test_resources/help/component_install

@@ -4,7 +4,8 @@ Usage:
   lacework component install <component> [flags]
 
 Flags:
-  -h, --help   help for install
+  -h, --help             help for install
+      --version string   require a specific version to be installed (default is latest)
 
 Global Flags:
   -a, --account string      account subdomain of URL (i.e. <ACCOUNT>.lacework.net)

integration/test_resources/help/component_list

@@ -1,4 +1,4 @@
-List all components
+List all available components and their current state
 
 Usage:
   lacework component list [flags]

integration/test_resources/help/component_show

@@ -0,0 +1,21 @@
+Show details about a component
+
+Usage:
+  lacework component show <component> [flags]
+
+Flags:
+  -h, --help   help for show
+
+Global Flags:
+  -a, --account string      account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
+  -k, --api_key string      access key id
+  -s, --api_secret string   secret access key
+      --api_token string    access token (replaces the use of api_key and api_secret)
+      --debug               turn on debug logging
+      --json                switch commands output from human-readable to json format
+      --nocache             turn off caching
+      --nocolor             turn off colors
+      --noninteractive      turn off interactive mode (disable spinners, prompts, etc.)
+      --organization        access organization level data sets (org admins only)
+  -p, --profile string      switch between profiles configured at ~/.lacework.toml
+      --subaccount string   sub-account name inside your organization (org admins only)

integration/test_resources/help/component_update

@@ -3,8 +3,12 @@ Update an existing component
 Usage:
   lacework component update <component> [flags]
 
+Aliases:
+  update, upgrade
+
 Flags:
-  -h, --help   help for update
+  -h, --help             help for update
+      --version string   update to a specific version (default is latest)
 
 Global Flags:
   -a, --account string      account subdomain of URL (i.e. <ACCOUNT>.lacework.net)

integration/test_resources/help/no-command-provided

@@ -22,6 +22,7 @@ Available Commands:
   api                     Helper to call Lacework's API
   cloud-account           Manage cloud accounts
   compliance              Manage compliance reports
+  component               Manage components
   configure               Configure the Lacework CLI
   container-registry      Manage container registries
   generate                Generate code to onboard your account