Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/commit-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion cli/cmd/component.go
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
9 changes: 5 additions & 4 deletions integration/test_resources/help/component
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion integration/test_resources/help/component_install
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion integration/test_resources/help/component_list
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
List all components
List all available components and their current state

Usage:
lacework component list [flags]
Expand Down
21 changes: 21 additions & 0 deletions integration/test_resources/help/component_show
Original file line number Diff line number Diff line change
@@ -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)
6 changes: 5 additions & 1 deletion integration/test_resources/help/component_update
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions integration/test_resources/help/no-command-provided
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading