diff --git a/clihandler/cmd/download.go b/clihandler/cmd/download.go index d0cc342d..412c3733 100644 --- a/clihandler/cmd/download.go +++ b/clihandler/cmd/download.go @@ -12,10 +12,36 @@ import ( var downloadInfo = cautils.DownloadInfo{} +var ( + downloadExample = ` + # Download all artifacts and save them in the default path (~/.kubescape) + kubescape download artifacts + + # Download all artifacts and save them in /tmp path + kubescape download artifacts --output /tmp + + # Download the NSA framework. Run 'kubescape list frameworks' for all frameworks names + kubescape download frameworks nsa + + # Download the "Allowed hostPath" control. Run 'kubescape list controls' for all controls names + kubescape download control "Allowed hostPath" + + # Download the "C-0001" control. Run 'kubescape list controls --id' for all controls ids + kubescape download control C-0001 + + # Download the configured exceptions + kubescape download exceptions + + # Download the configured controls-inputs + kubescape download controls-inputs + +` +) var downloadCmd = &cobra.Command{ - Use: "download ", - Short: fmt.Sprintf("Download %s", strings.Join(clihandler.DownloadSupportCommands(), "/")), - Long: ``, + Use: "download ", + Short: fmt.Sprintf("Download %s", strings.Join(clihandler.DownloadSupportCommands(), ",")), + Long: ``, + Example: downloadExample, Args: func(cmd *cobra.Command, args []string) error { supported := strings.Join(clihandler.DownloadSupportCommands(), ",") if len(args) < 1 { diff --git a/clihandler/cmd/list.go b/clihandler/cmd/list.go index 0d516854..06befd99 100644 --- a/clihandler/cmd/list.go +++ b/clihandler/cmd/list.go @@ -21,7 +21,7 @@ var ( # List all supported controls names kubescape list controls - # List all supported controls id's + # List all supported controls ids kubescape list controls --id Control documentation: