docs: add clear information about token requirement

owenrumney · owenrumney · commit d319e1900963 · 2025-10-30T17:05:43.000Z
diff --git a/docs/docs/references/configuration/cli/trivy_config.md b/docs/docs/references/configuration/cli/trivy_config.md
@@ -14,12 +14,12 @@ trivy config [flags] DIR
       --cf-params strings                 specify paths to override the CloudFormation parameters files
       --check-namespaces strings          Rego namespaces
       --checks-bundle-repository string   OCI registry URL to retrieve checks bundle from (default "mirror.gcr.io/aquasec/trivy-checks:1")
-      --cloud-api-url string              API URL for Trivy Cloud platform (default "https://api.trivy.dev")
-      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform (default true)
+      --cloud-api-url string              API URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://api.trivy.dev")
+      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --cloud-token string                Token used to athenticate with Trivy Cloud platform
-      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform (default "https://scan.trivy.dev")
-      --cloud-upload-results              Upload results to Trivy Cloud platform (default true)
-      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform (default true)
+      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://scan.trivy.dev")
+      --cloud-upload-results              Upload results to Trivy Cloud platform, requires the token to be provided to have an effect (default true)
+      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --compliance string                 compliance report to generate
       --config-check strings              specify the paths to the Rego check files or to the directories containing them, applying config files
       --config-data strings               specify paths from which data for the Rego checks will be recursively loaded
diff --git a/docs/docs/references/configuration/cli/trivy_filesystem.md b/docs/docs/references/configuration/cli/trivy_filesystem.md
@@ -24,12 +24,12 @@ trivy filesystem [flags] PATH
       --cf-params strings                 specify paths to override the CloudFormation parameters files
       --check-namespaces strings          Rego namespaces
       --checks-bundle-repository string   OCI registry URL to retrieve checks bundle from (default "mirror.gcr.io/aquasec/trivy-checks:1")
-      --cloud-api-url string              API URL for Trivy Cloud platform (default "https://api.trivy.dev")
-      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform (default true)
+      --cloud-api-url string              API URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://api.trivy.dev")
+      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --cloud-token string                Token used to athenticate with Trivy Cloud platform
-      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform (default "https://scan.trivy.dev")
-      --cloud-upload-results              Upload results to Trivy Cloud platform (default true)
-      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform (default true)
+      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://scan.trivy.dev")
+      --cloud-upload-results              Upload results to Trivy Cloud platform, requires the token to be provided to have an effect (default true)
+      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --compliance string                 compliance report to generate
       --config-check strings              specify the paths to the Rego check files or to the directories containing them, applying config files
       --config-data strings               specify paths from which data for the Rego checks will be recursively loaded
diff --git a/docs/docs/references/configuration/cli/trivy_image.md b/docs/docs/references/configuration/cli/trivy_image.md
@@ -38,12 +38,12 @@ trivy image [flags] IMAGE_NAME
       --cache-ttl duration                cache TTL when using redis as cache backend
       --check-namespaces strings          Rego namespaces
       --checks-bundle-repository string   OCI registry URL to retrieve checks bundle from (default "mirror.gcr.io/aquasec/trivy-checks:1")
-      --cloud-api-url string              API URL for Trivy Cloud platform (default "https://api.trivy.dev")
-      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform (default true)
+      --cloud-api-url string              API URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://api.trivy.dev")
+      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --cloud-token string                Token used to athenticate with Trivy Cloud platform
-      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform (default "https://scan.trivy.dev")
-      --cloud-upload-results              Upload results to Trivy Cloud platform (default true)
-      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform (default true)
+      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://scan.trivy.dev")
+      --cloud-upload-results              Upload results to Trivy Cloud platform, requires the token to be provided to have an effect (default true)
+      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --compliance string                 compliance report to generate (built-in compliance's: docker-cis-1.6.0)
       --config-check strings              specify the paths to the Rego check files or to the directories containing them, applying config files
       --config-data strings               specify paths from which data for the Rego checks will be recursively loaded
diff --git a/docs/docs/references/configuration/cli/trivy_repository.md b/docs/docs/references/configuration/cli/trivy_repository.md
@@ -24,12 +24,12 @@ trivy repository [flags] (REPO_PATH | REPO_URL)
       --cf-params strings                 specify paths to override the CloudFormation parameters files
       --check-namespaces strings          Rego namespaces
       --checks-bundle-repository string   OCI registry URL to retrieve checks bundle from (default "mirror.gcr.io/aquasec/trivy-checks:1")
-      --cloud-api-url string              API URL for Trivy Cloud platform (default "https://api.trivy.dev")
-      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform (default true)
+      --cloud-api-url string              API URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://api.trivy.dev")
+      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --cloud-token string                Token used to athenticate with Trivy Cloud platform
-      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform (default "https://scan.trivy.dev")
-      --cloud-upload-results              Upload results to Trivy Cloud platform (default true)
-      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform (default true)
+      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://scan.trivy.dev")
+      --cloud-upload-results              Upload results to Trivy Cloud platform, requires the token to be provided to have an effect (default true)
+      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --commit string                     pass the commit hash to be scanned
       --config-check strings              specify the paths to the Rego check files or to the directories containing them, applying config files
       --config-data strings               specify paths from which data for the Rego checks will be recursively loaded
diff --git a/docs/docs/references/configuration/cli/trivy_rootfs.md b/docs/docs/references/configuration/cli/trivy_rootfs.md
@@ -27,12 +27,12 @@ trivy rootfs [flags] ROOTDIR
       --cf-params strings                 specify paths to override the CloudFormation parameters files
       --check-namespaces strings          Rego namespaces
       --checks-bundle-repository string   OCI registry URL to retrieve checks bundle from (default "mirror.gcr.io/aquasec/trivy-checks:1")
-      --cloud-api-url string              API URL for Trivy Cloud platform (default "https://api.trivy.dev")
-      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform (default true)
+      --cloud-api-url string              API URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://api.trivy.dev")
+      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --cloud-token string                Token used to athenticate with Trivy Cloud platform
-      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform (default "https://scan.trivy.dev")
-      --cloud-upload-results              Upload results to Trivy Cloud platform (default true)
-      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform (default true)
+      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://scan.trivy.dev")
+      --cloud-upload-results              Upload results to Trivy Cloud platform, requires the token to be provided to have an effect (default true)
+      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --config-check strings              specify the paths to the Rego check files or to the directories containing them, applying config files
       --config-data strings               specify paths from which data for the Rego checks will be recursively loaded
       --config-file-schemas strings       specify paths to JSON configuration file schemas to determine that a file matches some configuration and pass the schema to Rego checks for type checking
diff --git a/docs/docs/references/configuration/cli/trivy_vm.md b/docs/docs/references/configuration/cli/trivy_vm.md
@@ -24,12 +24,12 @@ trivy vm [flags] VM_IMAGE
       --cache-backend string              [EXPERIMENTAL] cache backend (e.g. redis://localhost:6379) (default "fs")
       --cache-ttl duration                cache TTL when using redis as cache backend
       --checks-bundle-repository string   OCI registry URL to retrieve checks bundle from (default "mirror.gcr.io/aquasec/trivy-checks:1")
-      --cloud-api-url string              API URL for Trivy Cloud platform (default "https://api.trivy.dev")
-      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform (default true)
+      --cloud-api-url string              API URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://api.trivy.dev")
+      --cloud-server-scanning             Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --cloud-token string                Token used to athenticate with Trivy Cloud platform
-      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform (default "https://scan.trivy.dev")
-      --cloud-upload-results              Upload results to Trivy Cloud platform (default true)
-      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform (default true)
+      --cloud-trivy-server-url string     Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect (default "https://scan.trivy.dev")
+      --cloud-upload-results              Upload results to Trivy Cloud platform, requires the token to be provided to have an effect (default true)
+      --cloud-use-secret-config           Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect (default true)
       --compliance string                 compliance report to generate
       --config-file-schemas strings       specify paths to JSON configuration file schemas to determine that a file matches some configuration and pass the schema to Rego checks for type checking
       --custom-headers strings            custom headers in client mode
diff --git a/pkg/flag/cloud_flags.go b/pkg/flag/cloud_flags.go
@@ -16,49 +16,50 @@ var (
 		Name:          "cloud-api-url",
 		ConfigName:    "cloud.api-url",
 		Default:       DefaultApiURL,
-		Usage:         "API URL for Trivy Cloud platform",
+		Usage:         "API URL for Trivy Cloud platform, requires the token to be provided to have an effect",
 		TelemetrySafe: true,
 	}
 
 	CloudTrivyServerURLFlag = Flag[string]{
 		Name:          "cloud-trivy-server-url",
 		ConfigName:    "cloud.trivy-server-url",
 		Default:       DefaultTrivyServerURL,
-		Usage:         "Trivy Server URL for Trivy Cloud platform",
+		Usage:         "Trivy Server URL for Trivy Cloud platform, requires the token to be provided to have an effect",
 		TelemetrySafe: true,
 	}
 
 	CloudUploadResultsFlag = Flag[bool]{
 		Name:          "cloud-upload-results",
 		ConfigName:    "cloud.upload-results",
 		Default:       true,
-		Usage:         "Upload results to Trivy Cloud platform",
+		Usage:         "Upload results to Trivy Cloud platform, requires the token to be provided to have an effect",
 		TelemetrySafe: true,
 	}
 
 	CloudSecretConfigFlag = Flag[bool]{
 		Name:          "cloud-use-secret-config",
 		ConfigName:    "cloud.use-secret-config",
 		Default:       true,
-		Usage:         "Use secret configurations from Trivy Cloud platform",
+		Usage:         "Use secret configurations from Trivy Cloud platform, requires the token to be provided to have an effect",
 		TelemetrySafe: true,
 	}
 
 	CloudUseServerSideScanningFlag = Flag[bool]{
 		Name:          "cloud-server-scanning",
 		ConfigName:    "cloud.server-scanning",
 		Default:       true,
-		Usage:         "Use server-side image scanning in Trivy Cloud platform",
+		Usage:         "Use server-side image scanning in Trivy Cloud platform, requires the token to be provided to have an effect",
 		TelemetrySafe: true,
 	}
 )
 
 type CloudFlagGroup struct {
-	CloudToken                 *Flag[string]
-	CloudApiURL                *Flag[string]
-	CloudTrivyServerURL        *Flag[string]
-	CloudUploadResults         *Flag[bool]
-	CloudSecretConfig          *Flag[bool]
+	CloudToken          *Flag[string]
+	CloudApiURL         *Flag[string]
+	CloudTrivyServerURL *Flag[string]
+	CloudUploadResults  *Flag[bool]
+	CloudSecretConfig   *Flag[bool]
+
 	CloudUseServerSideScanning *Flag[bool]
 }
 
