From b719a5009cd1e64e329375b4450ce910b9b4c077 Mon Sep 17 00:00:00 2001 From: Itay Zagron Date: Wed, 19 Jan 2022 12:22:00 +0100 Subject: [PATCH 1/2] fix: Updated the policy download command message --- cmd/policy_download.go | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/cmd/policy_download.go b/cmd/policy_download.go index dce7839eff2..70d23ee914f 100644 --- a/cmd/policy_download.go +++ b/cmd/policy_download.go @@ -17,17 +17,11 @@ var ( Long: policyDownloadHelpMsg, Example: ` # Download official policy - cloudquery policy download aws-cis-1.2.0 + cloudquery policy download aws # The following will be the same as above # Official policies are hosted here: https://github.com/cloudquery-policies - cloudquery policy download cloudquery-policies/aws-cis-1.2.0 - - # Download community policy - cloudquery policy download COMMUNITY_GITHUB_ORG/aws-cis-1.2.0 - - # Download community from any source control - cloudquery policy download https://github.com/COMMUNITY_GITHUB_ORG/aws-cis-1.2.0 + cloudquery policy download aws//cis-1.2.0 # See https://hub.cloudquery.io for additional policies.`, Args: cobra.ExactArgs(1), From e5c796064cf66467fc59355c5e5831ff523b2b8a Mon Sep 17 00:00:00 2001 From: Itay Zagron Date: Wed, 19 Jan 2022 18:25:53 +0100 Subject: [PATCH 2/2] updated policy commands examples --- cmd/policy_describe.go | 14 +++++++++++++- cmd/policy_download.go | 3 +++ cmd/policy_run.go | 12 ++++++++++-- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/cmd/policy_describe.go b/cmd/policy_describe.go index 4ec3171e897..b801ef6332a 100644 --- a/cmd/policy_describe.go +++ b/cmd/policy_describe.go @@ -14,7 +14,19 @@ var ( Use: "describe", Short: policyDescribeHelpMsg, Long: policyDescribeHelpMsg, - Args: cobra.ExactArgs(1), + Example: ` + # Describe official policy + cloudquery policy describe aws + + # The following will be the same as above + # Official policies are hosted here: https://github.com/cloudquery-policies + cloudquery policy describe aws//cis-1.2.0 + + # Describe community policy + cloudquery policy describe github.com/COMMUNITY_GITHUB_ORG/aws + + # See https://hub.cloudquery.io for additional policies.`, + Args: cobra.ExactArgs(1), Run: handleCommand(func(ctx context.Context, c *console.Client, cmd *cobra.Command, args []string) error { return c.DescribePolicies(ctx, args[0]) }), diff --git a/cmd/policy_download.go b/cmd/policy_download.go index 70d23ee914f..2d8731b4d2a 100644 --- a/cmd/policy_download.go +++ b/cmd/policy_download.go @@ -22,6 +22,9 @@ var ( # The following will be the same as above # Official policies are hosted here: https://github.com/cloudquery-policies cloudquery policy download aws//cis-1.2.0 + + # Download community policy + cloudquery policy download github.com/COMMUNITY_GITHUB_ORG/aws # See https://hub.cloudquery.io for additional policies.`, Args: cobra.ExactArgs(1), diff --git a/cmd/policy_run.go b/cmd/policy_run.go index 0915f0fc751..7dcbc4b4b5c 100644 --- a/cmd/policy_run.go +++ b/cmd/policy_run.go @@ -19,8 +19,16 @@ var ( # Download & Run the policies defined in your config cloudquery policy run - # Run a specific policy by it's name - cloudquery policy run --policy my_aws_policy + # Run a specific policy that is not defined in the config.hcl + # Run official policy + cloudquery policy run aws + + # The following will be the same as above + # Official policies are hosted here: https://github.com/cloudquery-policies + cloudquery policy run aws//cis_v1.2.0 + + # Run community policy + cloudquery policy run github.com/COMMUNITY_GITHUB_ORG/aws # See https://hub.cloudquery.io for additional policies.`, Run: handleCommand(func(ctx context.Context, c *console.Client, cmd *cobra.Command, args []string) error {