chore: Replace starboard get report with starboard report command

Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
aquasecurity · Oct 2, 2021 · a0d55a0 · a0d55a0
1 parent f09d170
commit a0d55a0
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/cli/getting-started.md b/docs/cli/getting-started.md
@@ -55,7 +55,7 @@ images associated with the specified deployment. Once this has been done, you ca
 reports for this workload:
 
 ```
-starboard get vulnerabilities deployment/nginx -o yaml
+starboard get vulnerabilityreports deployment/nginx -o yaml
 ```
 
 !!! tip
@@ -67,7 +67,7 @@ starboard get vulnerabilities deployment/nginx -o yaml
 
     ```console
     $ kubectl get vulnerabilityreports -o wide \
-    >  -l starboard.resource.kind=Deployment,starboard.resource.name=nginx
+       -l starboard.resource.kind=Deployment,starboard.resource.name=nginx
     NAME                     REPOSITORY      TAG    SCANNER   AGE    CRITICAL   HIGH   MEDIUM   LOW   UNKNOWN
     deployment-nginx-nginx   library/nginx   1.16   Trivy     2m6s   3          40     24       90    0
     ```
@@ -94,14 +94,14 @@ starboard scan configauditreports deployment/nginx
 Retrieve the configuration audit report:
 
 ```
-starboard get configaudit deployment/nginx -o yaml
+starboard get configauditreports deployment/nginx -o yaml
 ```
 
 or
 
 ```console
 $ kubectl get configauditreport -o wide \
->  -l starboard.resource.kind=Deployment,starboard.resource.name=nginx
+    -l starboard.resource.kind=Deployment,starboard.resource.name=nginx
 NAME               SCANNER   AGE   DANGER   WARNING   PASS
 deployment-nginx   Polaris   5s    0        8         9
 ```
@@ -112,7 +112,7 @@ Once you scanned the `nginx` Deployment for vulnerabilities and checked its conf
 report of identified risks:
 
 ```
-starboard get report deployment/nginx > nginx.deploy.html
+starboard report deployment/nginx > nginx.deploy.html
 ```
 
 ```

diff --git a/pkg/cmd/get.go b/pkg/cmd/get.go
@@ -15,7 +15,6 @@ func NewGetCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags,
 	}
 	getCmd.AddCommand(NewGetVulnerabilityReportsCmd(buildInfo.Executable, cf, outWriter))
 	getCmd.AddCommand(NewGetConfigAuditReportsCmd(buildInfo.Executable, cf, outWriter))
-	getCmd.AddCommand(NewGetReportCmd(buildInfo, cf, outWriter))
 	getCmd.PersistentFlags().StringP("output", "o", "yaml", "Output format. One of yaml|json")
 
 	return getCmd

diff --git a/pkg/cmd/root.go b/pkg/cmd/root.go
@@ -34,7 +34,7 @@ $ %[1]s scan vulnerabilityreports deployment/nginx
 
 Once this has been done, you can retrieve the vulnerability report:
 
-$ %[1]s get vulnerabilities deployment/nginx -o yaml
+$ %[1]s get vulnerabilityreports deployment/nginx -o yaml
 `
 )
 
@@ -55,6 +55,7 @@ func NewRootCmd(buildInfo starboard.BuildInfo, args []string, outWriter io.Write
 	rootCmd.AddCommand(NewInitCmd(buildInfo, cf))
 	rootCmd.AddCommand(NewScanCmd(buildInfo, cf))
 	rootCmd.AddCommand(NewGetCmd(buildInfo, cf, outWriter))
+	rootCmd.AddCommand(NewGetReportCmd(buildInfo, cf, outWriter))
 	rootCmd.AddCommand(NewCleanupCmd(buildInfo, cf))
 	rootCmd.AddCommand(NewConfigCmd(cf, outWriter))