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 dce7839eff2..2d8731b4d2a 100644 --- a/cmd/policy_download.go +++ b/cmd/policy_download.go @@ -17,17 +17,14 @@ 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 - + cloudquery policy download 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 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 {