diff --git a/apps/cnquery/cmd/bundle.go b/apps/cnquery/cmd/bundle.go index 147bdbd0dd..e7f93cb142 100644 --- a/apps/cnquery/cmd/bundle.go +++ b/apps/cnquery/cmd/bundle.go @@ -48,7 +48,7 @@ var embedQueryPackTemplate []byte var queryPackInitCmd = &cobra.Command{ Use: "init [path]", Short: "Create an example query pack", - Long: "Create an example query pack that you can use as a starting point. If you don't provide a filename, cnquery uses `example-pack.mql.yaml`.", + Long: "Create an example query pack that you can use as a starting point. If you don't provide a filename, cnquery uses `example-pack.mql.yaml`", Args: cobra.MaximumNArgs(1), Run: func(cmd *cobra.Command, args []string) { name := "example-pack.mql.yaml" diff --git a/apps/cnquery/cmd/login.go b/apps/cnquery/cmd/login.go index 3d76e746f6..e5c1b4192c 100644 --- a/apps/cnquery/cmd/login.go +++ b/apps/cnquery/cmd/login.go @@ -28,12 +28,12 @@ import ( func init() { rootCmd.AddCommand(LoginCmd) - LoginCmd.Flags().StringP("token", "t", "", "Set a client registration token.") - LoginCmd.Flags().StringToString("annotation", nil, "Set the client annotations.") - LoginCmd.Flags().String("name", "", "Set asset name.") - LoginCmd.Flags().String("api-endpoint", "", "Set the Mondoo API endpoint.") - LoginCmd.Flags().Int("timer", 0, "Set the scan interval in minutes.") - LoginCmd.Flags().Int("splay", 0, "Randomize the timer by up to this many minutes.") + LoginCmd.Flags().StringP("token", "t", "", "Set a client registration token") + LoginCmd.Flags().StringToString("annotation", nil, "Set the client annotations") + LoginCmd.Flags().String("name", "", "Set asset name") + LoginCmd.Flags().String("api-endpoint", "", "Set the Mondoo API endpoint") + LoginCmd.Flags().Int("timer", 0, "Set the scan interval in minutes") + LoginCmd.Flags().Int("splay", 0, "Randomize the timer by up to this many minutes") } var LoginCmd = &cobra.Command{ @@ -41,11 +41,11 @@ var LoginCmd = &cobra.Command{ Aliases: []string{"register"}, Short: "Register with Mondoo Platform", Long: ` -Log in to Mondoo Platform using a registration token. To pass in the token, use +Log in to Mondoo Platform using a registration token. To pass in the token, use the '--token' flag. You can generate a new registration token on the Mondoo Dashboard. Go to -https://console.mondoo.com -> Space -> Settings -> Registration Token. Copy the token and pass it in +https://console.mondoo.com -> Space -> Settings -> Registration Token. Copy the token and pass it in using the '--token' argument. You remain logged in until you explicitly log out using the 'logout' subcommand. diff --git a/apps/cnquery/cmd/providers.go b/apps/cnquery/cmd/providers.go index 6ba3ffeb8d..058e6280f4 100644 --- a/apps/cnquery/cmd/providers.go +++ b/apps/cnquery/cmd/providers.go @@ -31,7 +31,7 @@ func init() { var ProvidersCmd = &cobra.Command{ Use: "providers", Short: "Providers add connectivity to all assets", - Long: `Manage your providers. List and install new ones or update existing ones.`, + Long: `Manage your providers. List and install new ones or update existing ones`, PreRun: func(cmd *cobra.Command, args []string) {}, Run: func(cmd *cobra.Command, args []string) { list() @@ -40,7 +40,7 @@ var ProvidersCmd = &cobra.Command{ var listProvidersCmd = &cobra.Command{ Use: "list", - Short: "List all providers on the system.", + Short: "List all providers on the system", Long: "", PreRun: func(cmd *cobra.Command, args []string) {}, Run: func(cmd *cobra.Command, args []string) { @@ -50,7 +50,7 @@ var listProvidersCmd = &cobra.Command{ var installProviderCmd = &cobra.Command{ Use: "install ", - Short: "Install or update a provider.", + Short: "Install or update a provider", Long: "", PreRun: func(cmd *cobra.Command, args []string) {}, Run: func(cmd *cobra.Command, args []string) { diff --git a/apps/cnquery/cmd/root.go b/apps/cnquery/cmd/root.go index b0cb4d00b7..455808d138 100644 --- a/apps/cnquery/cmd/root.go +++ b/apps/cnquery/cmd/root.go @@ -114,7 +114,7 @@ func init() { rootCmd.PersistentFlags().BoolP("verbose", "v", false, "Enable verbose output") rootCmd.PersistentFlags().String("log-level", "info", "Set log level: error, warn, info, debug, trace") - rootCmd.PersistentFlags().String("api-proxy", "", "Set proxy for communications with Mondoo API") + rootCmd.PersistentFlags().String("api-proxy", "", "Set proxy for communications with Mondoo Platform API") rootCmd.PersistentFlags().Bool("auto-update", true, "Enable automatic provider installation and update") viper.BindPFlag("verbose", rootCmd.PersistentFlags().Lookup("verbose")) viper.BindPFlag("log-level", rootCmd.PersistentFlags().Lookup("log-level")) diff --git a/apps/cnquery/cmd/run.go b/apps/cnquery/cmd/run.go index 2dba2f926d..b409d7f676 100644 --- a/apps/cnquery/cmd/run.go +++ b/apps/cnquery/cmd/run.go @@ -19,14 +19,14 @@ import ( func init() { rootCmd.AddCommand(RunCmd) - RunCmd.Flags().StringP("command", "c", "", "MQL query to executed in the shell.") - RunCmd.Flags().Bool("parse", false, "Parse the query and return the logical structure.") - RunCmd.Flags().Bool("ast", false, "Parse the query and return the abstract syntax tree (AST).") - RunCmd.Flags().Bool("info", false, "Parse the query and provide information about it.") - RunCmd.Flags().BoolP("json", "j", false, "Run the query and return the object in a JSON structure.") - RunCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID.") + RunCmd.Flags().StringP("command", "c", "", "MQL query to executed in the shell") + RunCmd.Flags().Bool("parse", false, "Parse the query and return the logical structure") + RunCmd.Flags().Bool("ast", false, "Parse the query and return the abstract syntax tree (AST)") + RunCmd.Flags().Bool("info", false, "Parse the query and provide information about it") + RunCmd.Flags().BoolP("json", "j", false, "Run the query and return the object in a JSON structure") + RunCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID") - RunCmd.Flags().String("llx", "", "Generate the executable code bundle and save it to the specified file.") + RunCmd.Flags().String("llx", "", "Generate the executable code bundle and save it to the specified file") RunCmd.Flags().MarkHidden("llx") RunCmd.Flags().String("use-llx", "", "Run the code specified in the code bundle on disk") _ = RunCmd.Flags().MarkHidden("use-llx") diff --git a/apps/cnquery/cmd/sbom.go b/apps/cnquery/cmd/sbom.go index dd85696bd1..06ac8d9876 100644 --- a/apps/cnquery/cmd/sbom.go +++ b/apps/cnquery/cmd/sbom.go @@ -23,10 +23,10 @@ import ( func init() { rootCmd.AddCommand(sbomCmd) - sbomCmd.Flags().String("asset-name", "", "User-override for the asset name.") - sbomCmd.Flags().StringToString("annotation", nil, "Add an annotation to the asset.") // user-added, editable + sbomCmd.Flags().String("asset-name", "", "User-override for the asset name") + sbomCmd.Flags().StringToString("annotation", nil, "Add an annotation to the asset") // user-added, editable sbomCmd.Flags().StringP("output", "o", "list", "Set output format: "+sbom.AllFormats()) - sbomCmd.Flags().String("output-target", "", "Set output target to which the sbom report will be written.") + sbomCmd.Flags().String("output-target", "", "Set output target to which the SBOM report will be written") sbomCmd.Flags().Bool("with-evidence", false, "Display evidence for each component") } diff --git a/apps/cnquery/cmd/scan.go b/apps/cnquery/cmd/scan.go index 4661df5339..e5b6d00fed 100644 --- a/apps/cnquery/cmd/scan.go +++ b/apps/cnquery/cmd/scan.go @@ -27,41 +27,41 @@ func init() { rootCmd.AddCommand(scanCmd) _ = scanCmd.Flags().StringP("output", "o", "compact", "Set output format: "+reporter.AllFormats()) - _ = scanCmd.Flags().BoolP("json", "j", false, "Run the query and return the object in a JSON structure.") - _ = scanCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID.") + _ = scanCmd.Flags().BoolP("json", "j", false, "Run the query and return the object in a JSON structure") + _ = scanCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID") - _ = scanCmd.Flags().String("inventory-file", "", "Set the path to the inventory file.") - _ = scanCmd.Flags().String("inventory-template", "", "Set the path to the inventory template.") + _ = scanCmd.Flags().String("inventory-file", "", "Set the path to the inventory file") + _ = scanCmd.Flags().String("inventory-template", "", "Set the path to the inventory template") _ = scanCmd.Flags().MarkHidden("inventory-template") - _ = scanCmd.Flags().Bool("inventory-format-ansible", false, "Set the inventory format to Ansible.") + _ = scanCmd.Flags().Bool("inventory-format-ansible", false, "Set the inventory format to Ansible") // "inventory-ansible" is deprecated, use "inventory-format-ansible" instead - _ = scanCmd.Flags().Bool("inventory-ansible", false, "Set the inventory format to Ansible.") + _ = scanCmd.Flags().Bool("inventory-ansible", false, "Set the inventory format to Ansible") _ = scanCmd.Flags().MarkDeprecated("inventory-ansible", "use --inventory-format-ansible") _ = scanCmd.Flags().MarkHidden("inventory-ansible") - _ = scanCmd.Flags().Bool("inventory-format-domainlist", false, "Set the inventory format to domain list.") + _ = scanCmd.Flags().Bool("inventory-format-domainlist", false, "Set the inventory format to domain list") // "inventory-domainlist" is deprecated, use "inventory-format-domainlist" instead - _ = scanCmd.Flags().Bool("inventory-domainlist", false, "Set the inventory format to domain list.") + _ = scanCmd.Flags().Bool("inventory-domainlist", false, "Set the inventory format to domain list") _ = scanCmd.Flags().MarkDeprecated("inventory-domainlist", "use --inventory-format-domainlist") _ = scanCmd.Flags().MarkHidden("inventory-domainlist") // bundles, packs & incognito mode - _ = scanCmd.Flags().Bool("incognito", false, "Run in incognito mode. Do not report scan results to Mondoo Platform.") - _ = scanCmd.Flags().StringSlice("querypack", nil, "Set the query packs to execute. This requires `querypack-bundle`. You can specify multiple UIDs.") + _ = scanCmd.Flags().Bool("incognito", false, "Run in incognito mode. Do not report scan results to Mondoo Platform") + _ = scanCmd.Flags().StringSlice("querypack", nil, "Set the query packs to execute. This requires `querypack-bundle`. You can specify multiple UIDs") _ = scanCmd.Flags().StringSliceP("querypack-bundle", "f", nil, "Path to local query pack file") // flag completion command _ = scanCmd.RegisterFlagCompletionFunc("querypack", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { return getQueryPacksForCompletion(), cobra.ShellCompDirectiveDefault }) _ = scanCmd.Flags().String("asset-name", "", "User-override for the asset name") - _ = scanCmd.Flags().StringToString("annotation", nil, "Add an annotation to the asset.") // user-added, editable + _ = scanCmd.Flags().StringToString("annotation", nil, "Add an annotation to the asset") // user-added, editable _ = scanCmd.Flags().StringToString("props", nil, "Custom values for properties") _ = scanCmd.Flags().String("trace-id", "", "Trace identifier") // v6 should make detect-cicd and category flag public - _ = scanCmd.Flags().Bool("detect-cicd", true, "Try to detect CI/CD environments. If detected, set the asset category to 'cicd'.") - _ = scanCmd.Flags().String("category", "inventory", "Set the category for the assets to 'inventory|cicd'.") + _ = scanCmd.Flags().Bool("detect-cicd", true, "Try to detect CI/CD environments. If detected, set the asset category to 'cicd'") + _ = scanCmd.Flags().String("category", "inventory", "Set the category for the assets to 'inventory|cicd'") _ = scanCmd.Flags().MarkHidden("category") } diff --git a/apps/cnquery/cmd/shell.go b/apps/cnquery/cmd/shell.go index e2d1336b03..0adb502ee8 100644 --- a/apps/cnquery/cmd/shell.go +++ b/apps/cnquery/cmd/shell.go @@ -27,8 +27,8 @@ import ( func init() { rootCmd.AddCommand(shellCmd) - shellCmd.Flags().StringP("command", "c", "", "MQL query to executed in the shell.") - shellCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID.") + shellCmd.Flags().StringP("command", "c", "", "MQL query to executed in the shell") + shellCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID") shellCmd.Flags().StringToString("annotations", nil, "Specify annotations for this run") _ = shellCmd.Flags().MarkHidden("annotations") } diff --git a/apps/cnquery/cmd/vault.go b/apps/cnquery/cmd/vault.go index 626bf783cc..3dffb787b6 100644 --- a/apps/cnquery/cmd/vault.go +++ b/apps/cnquery/cmd/vault.go @@ -22,13 +22,13 @@ func init() { vaultConfigureCmd.Flags().String("type", "", "possible values: "+strings.Join(vault.TypeIds(), " | ")) vaultConfigureCmd.Flags().StringToString("option", nil, "addition vault connection options, multiple options via --option key=value") - vaultConfigureCmd.Flags().String("inventory-file", "", "Set the path to the inventory file.") + vaultConfigureCmd.Flags().String("inventory-file", "", "Set the path to the inventory file") VaultCmd.AddCommand(vaultConfigureCmd) VaultCmd.AddCommand(vaultRemoveCmd) VaultCmd.AddCommand(vaultResetCmd) - vaultAddSecretCmd.Flags().String("inventory-file", "", "Set the path to the inventory file.") + vaultAddSecretCmd.Flags().String("inventory-file", "", "Set the path to the inventory file") vaultAddSecretCmd.MarkFlagRequired("inventory-file") VaultCmd.AddCommand(vaultAddSecretCmd) diff --git a/cli/config/config.go b/cli/config/config.go index a296befe20..36179f0921 100644 --- a/cli/config/config.go +++ b/cli/config/config.go @@ -201,7 +201,7 @@ type CommonOpts struct { // client features Features []string `json:"features,omitempty" mapstructure:"features"` - // API Proxy for communicating with Mondoo API + // API Proxy for communicating with Mondoo Platform API APIProxy string `json:"api_proxy,omitempty" mapstructure:"api_proxy"` // labels that will be applied to all assets diff --git a/providers/atlassian/config/config.go b/providers/atlassian/config/config.go index 3e307ff921..2f304db3e6 100644 --- a/providers/atlassian/config/config.go +++ b/providers/atlassian/config/config.go @@ -50,31 +50,31 @@ For SCIM, you receive both the token and the directory-id from Atlassian when yo Long: "admin-token", Type: plugin.FlagType_String, Default: "", - Desc: "Provide Atlassian admin API token (used for Atlassian admin).", + Desc: "Atlassian admin API token (used for Atlassian admin)", }, { Long: "host", Type: plugin.FlagType_String, Default: "", - Desc: "Provide Atlassian hostname (e.g. https://example.atlassian.net).", + Desc: "Atlassian hostname (e.g. https://example.atlassian.net)", }, { Long: "user", Type: plugin.FlagType_String, Default: "", - Desc: "Provide Atlassian user name (e.g. example@example.com).", + Desc: "Atlassian user name (e.g. example@example.com)", }, { Long: "user-token", Type: plugin.FlagType_String, Default: "", - Desc: "Provide Atlassian user API token (used for Jira / Confluence).", + Desc: "Atlassian user API token (used for Jira / Confluence)", }, { Long: "scim-token", Type: plugin.FlagType_String, Default: "", - Desc: "Provide Atlassian SCIM API token (used for SCIM).", + Desc: "Atlassian SCIM API token (used for SCIM)", }, }, }, diff --git a/providers/azure/config/config.go b/providers/azure/config/config.go index 5f0e9df9a2..98e67df290 100644 --- a/providers/azure/config/config.go +++ b/providers/azure/config/config.go @@ -46,56 +46,56 @@ var Config = plugin.Provider{ Long: "tenant-id", Type: plugin.FlagType_String, Default: "", - Desc: "Directory (tenant) ID of the service principal.", + Desc: "Directory (tenant) ID of the service principal", Option: plugin.FlagOption_Hidden, }, { Long: "client-id", Type: plugin.FlagType_String, Default: "", - Desc: "Application (client) ID of the service principal.", + Desc: "Application (client) ID of the service principal", Option: plugin.FlagOption_Hidden, }, { Long: "client-secret", Type: plugin.FlagType_String, Default: "", - Desc: "Secret for application.", + Desc: "Secret for application", Option: plugin.FlagOption_Hidden, }, { Long: "certificate-path", Type: plugin.FlagType_String, Default: "", - Desc: "Path (in PKCS #12/PFX or PEM format) to the authentication certificate.", + Desc: "Path (in PKCS #12/PFX or PEM format) to the authentication certificate", Option: plugin.FlagOption_Hidden, }, { Long: "certificate-secret", Type: plugin.FlagType_String, Default: "", - Desc: "Passphrase for the authentication certificate file.", + Desc: "Passphrase for the authentication certificate file", Option: plugin.FlagOption_Hidden, }, { Long: "subscription", Type: plugin.FlagType_String, Default: "", - Desc: "ID of the Azure subscription to scan.", + Desc: "ID of the Azure subscription to scan", Option: plugin.FlagOption_Hidden, }, { Long: "subscriptions", Type: plugin.FlagType_String, Default: "", - Desc: "Comma-separated list of Azure subscriptions to include.", + Desc: "Comma-separated list of Azure subscriptions to include", Option: plugin.FlagOption_Hidden, }, { Long: "subscriptions-exclude", Type: plugin.FlagType_String, Default: "", - Desc: "Comma-separated list of Azure subscriptions to exclude.", + Desc: "Comma-separated list of Azure subscriptions to exclude", Option: plugin.FlagOption_Hidden, }, }, diff --git a/providers/equinix/config/config.go b/providers/equinix/config/config.go index 12fcdd6bd5..dbed9ad15b 100644 --- a/providers/equinix/config/config.go +++ b/providers/equinix/config/config.go @@ -18,7 +18,7 @@ var Config = plugin.Provider{ Name: "equinix", Use: "equinix [org ] [project ] [--token ]", Short: "an Equinix Metal organization", - Long: `equinix is designed for querying resources within a specified + Long: `equinix is designed for querying resources within a specified project or organization on the Equinix Metal platform. Available Commands: @@ -35,7 +35,7 @@ If the PACKET_AUTH_TOKEN environment variable is set, the token flag is not requ Long: "token", Type: plugin.FlagType_String, Default: "", - Desc: " Specifies the Equinix API token for authenticating the user", + Desc: "The Equinix API token for authenticating the user", }, }, }, diff --git a/providers/github/config/config.go b/providers/github/config/config.go index 4c473a675e..433e693d92 100644 --- a/providers/github/config/config.go +++ b/providers/github/config/config.go @@ -27,43 +27,43 @@ var Config = plugin.Provider{ Long: "token", Type: plugin.FlagType_String, Default: "", - Desc: "Provide GitHub personal access token.", + Desc: "GitHub personal access token", }, { Long: "repos-exclude", Type: plugin.FlagType_String, Default: "", - Desc: "Filter out repositories matching these names.", + Desc: "Filter out repositories matching these names", }, { Long: "repos", Type: plugin.FlagType_String, Default: "", - Desc: "Only include repositories with matching names.", + Desc: "Only include repositories with matching names", }, { Long: "app-id", Type: plugin.FlagType_String, Default: "", - Desc: "GitHub App ID.", + Desc: "GitHub App ID", }, { Long: "app-installation-id", Type: plugin.FlagType_String, Default: "", - Desc: "GitHub App installation ID.", + Desc: "GitHub App installation ID", }, { Long: "app-private-key", Type: plugin.FlagType_String, Default: "", - Desc: "GitHub App private key file path.", + Desc: "GitHub App private key file path", }, { Long: "enterprise-url", Type: plugin.FlagType_String, Default: "", - Desc: "GitHub Enterprise URL.", + Desc: "GitHub Enterprise URL", }, }, }, diff --git a/providers/gitlab/config/config.go b/providers/gitlab/config/config.go index 4d225916f8..e3074d1d47 100644 --- a/providers/gitlab/config/config.go +++ b/providers/gitlab/config/config.go @@ -33,7 +33,7 @@ var Config = plugin.Provider{ Long: "token", Type: plugin.FlagType_String, Default: "", - Desc: "Provide GitLab personal access token.", + Desc: "GitLab personal access token", }, { Long: "group", diff --git a/providers/ipmi/config/config.go b/providers/ipmi/config/config.go index 7cbc61b71d..9d97361005 100644 --- a/providers/ipmi/config/config.go +++ b/providers/ipmi/config/config.go @@ -30,7 +30,7 @@ firmware (BIOS or UEFI), and operating system. Long: "ask-pass", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Prompt for connection password.", + Desc: "Prompt for connection password", ConfigEntry: "-", }, { @@ -38,7 +38,7 @@ firmware (BIOS or UEFI), and operating system. Short: "p", Type: plugin.FlagType_String, Default: "", - Desc: "Set the connection password for IPMI connection.", + Desc: "Set the connection password for IPMI connection", Option: plugin.FlagOption_Password, ConfigEntry: "-", }, diff --git a/providers/k8s/config/config.go b/providers/k8s/config/config.go index dde79dd906..f96e1772f9 100644 --- a/providers/k8s/config/config.go +++ b/providers/k8s/config/config.go @@ -44,19 +44,19 @@ var Config = plugin.Provider{ Long: "context", Type: plugin.FlagType_String, Default: "", - Desc: "Target a Kubernetes context.", + Desc: "Target a Kubernetes context", }, { Long: "namespaces-exclude", Type: plugin.FlagType_String, Default: "", - Desc: "Filter out Kubernetes objects in the matching namespaces.", + Desc: "Filter out Kubernetes objects in the matching namespaces", }, { Long: "namespaces", Type: plugin.FlagType_String, Default: "", - Desc: "Only include Kubernetes object in the matching namespaces.", + Desc: "Only include Kubernetes object in the matching namespaces", }, { Long: "container-proxy", diff --git a/providers/ms365/config/config.go b/providers/ms365/config/config.go index bff5678e2c..378833a243 100644 --- a/providers/ms365/config/config.go +++ b/providers/ms365/config/config.go @@ -26,43 +26,43 @@ var Config = plugin.Provider{ Long: "tenant-id", Type: plugin.FlagType_String, Default: "", - Desc: "Directory (tenant) ID of the service principal.", + Desc: "Directory (tenant) ID of the service principal", }, { Long: "client-id", Type: plugin.FlagType_String, Default: "", - Desc: "Application (client) ID of the service principal.", + Desc: "Application (client) ID of the service principal", }, { Long: "organization", Type: plugin.FlagType_String, Default: "", - Desc: "The organization to be scanned.", + Desc: "The organization to be scanned", }, { Long: "sharepoint-url", Type: plugin.FlagType_String, Default: "", - Desc: "The sharepoint URL to be scanned.", + Desc: "The sharepoint URL to be scanned", }, { Long: "client-secret", Type: plugin.FlagType_String, Default: "", - Desc: "Secret for application.", + Desc: "Secret for application", }, { Long: "certificate-path", Type: plugin.FlagType_String, Default: "", - Desc: "Path (in PKCS #12/PFX or PEM format) to the authentication certificate.", + Desc: "Path (in PKCS #12/PFX or PEM format) to the authentication certificate", }, { Long: "certificate-secret", Type: plugin.FlagType_String, Default: "", - Desc: "Passphrase for the authentication certificate file.", + Desc: "Passphrase for the authentication certificate file", }, }, }, diff --git a/providers/network/config/config.go b/providers/network/config/config.go index c53b484763..2d16c1ec5f 100644 --- a/providers/network/config/config.go +++ b/providers/network/config/config.go @@ -39,7 +39,7 @@ var Config = plugin.Provider{ Long: "insecure", Type: plugin.FlagType_Bool, Default: "", - Desc: "Disable TLS/SSL verification.", + Desc: "Disable TLS/SSL verification", }, }, }, diff --git a/providers/okta/config/config.go b/providers/okta/config/config.go index d22ee1b7b9..34e8b6605e 100644 --- a/providers/okta/config/config.go +++ b/providers/okta/config/config.go @@ -24,7 +24,7 @@ var Config = plugin.Provider{ Long: "organization", Type: plugin.FlagType_String, Default: "", - Desc: "Specify the Okta organization to scan", + Desc: "The Okta organization to scan", }, { Long: "token", diff --git a/providers/os/config/config.go b/providers/os/config/config.go index c9ee7476ba..d12de22580 100644 --- a/providers/os/config/config.go +++ b/providers/os/config/config.go @@ -46,7 +46,7 @@ var Config = plugin.Provider{ Long: "sudo", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Elevate privileges with sudo.", + Desc: "Elevate privileges with sudo", ConfigEntry: "sudo.active", }, { @@ -69,19 +69,19 @@ var Config = plugin.Provider{ Long: "sudo", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Elevate privileges with sudo.", + Desc: "Elevate privileges with sudo", }, { Long: "insecure", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Disable SSH hostkey verification.", + Desc: "Disable SSH hostkey verification", }, { Long: "ask-pass", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Prompt for connection password.", + Desc: "Prompt for connection password", ConfigEntry: "-", }, { @@ -89,7 +89,7 @@ var Config = plugin.Provider{ Short: "p", Type: plugin.FlagType_String, Default: "", - Desc: "Set the connection password for SSH.", + Desc: "Set the connection password for SSH", Option: plugin.FlagOption_Password, ConfigEntry: "-", }, @@ -98,7 +98,7 @@ var Config = plugin.Provider{ Short: "i", Type: plugin.FlagType_String, Default: "", - Desc: "Select a file from which to read the identity (private key) for public key authentication.", + Desc: "Select a file from which to read the identity (private key) for public key authentication", }, { Long: "id-detector", @@ -125,14 +125,14 @@ var Config = plugin.Provider{ { Long: "ask-pass", Default: "false", - Desc: "Prompt for connection password.", + Desc: "Prompt for connection password", Type: plugin.FlagType_Bool, }, { Long: "password", Short: "p", Default: "false", - Desc: "Set the connection password for SSH.", + Desc: "Set the connection password for SSH", Type: plugin.FlagType_String, Option: plugin.FlagOption_Password, ConfigEntry: "-", @@ -157,7 +157,7 @@ var Config = plugin.Provider{ Long: "sudo", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Elevate privileges with sudo.", + Desc: "Elevate privileges with sudo", }, { Long: "id-detector", @@ -183,7 +183,7 @@ var Config = plugin.Provider{ Long: "sudo", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Elevate privileges with sudo.", + Desc: "Elevate privileges with sudo", ConfigEntry: "sudo.active", }, { @@ -236,7 +236,7 @@ var Config = plugin.Provider{ Long: "disable-cache", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Disable the in-memory cache for images. WARNING: This will slow down scans significantly.", + Desc: "Disable the in-memory cache for images. WARNING: This will slow down scans significantly", }, { Long: "container-proxy", @@ -258,7 +258,7 @@ var Config = plugin.Provider{ Long: "path", Type: plugin.FlagType_String, Default: "", - Desc: "Path to a local file or directory for the connection to use.", + Desc: "Path to a local file or directory for the connection to use", Option: plugin.FlagOption_Deprecated, }, }, @@ -273,19 +273,19 @@ var Config = plugin.Provider{ { Long: "lun", Type: plugin.FlagType_String, - Desc: "The logical unit number of the block device that should be scanned. Do not use together with --device-name.", + Desc: "The logical unit number of the block device that should be scanned. Do not use together with --device-name", Option: plugin.FlagOption_Hidden, }, { Long: "device-name", Type: plugin.FlagType_String, - Desc: "The target device to scan, e.g. /dev/sda. Do not use together with --lun.", + Desc: "The target device to scan, e.g. /dev/sda. Do not use together with --lun", Option: plugin.FlagOption_Hidden, }, { Long: "platform-ids", Type: plugin.FlagType_List, - Desc: "List of platform IDs to inject to the asset.", + Desc: "List of platform IDs to inject to the asset", Option: plugin.FlagOption_Hidden, }, }, diff --git a/providers/terraform/config/config.go b/providers/terraform/config/config.go index 7e066873ff..f344494e43 100644 --- a/providers/terraform/config/config.go +++ b/providers/terraform/config/config.go @@ -32,7 +32,7 @@ var Config = plugin.Provider{ Long: "ignore-dot-terraform", Type: plugin.FlagType_Bool, Default: "false", - Desc: "Ignore the .terraform directory.", + Desc: "Ignore the .terraform directory", ConfigEntry: "ignore_dot_terraform", }, }, diff --git a/test/commands/testdata/cnquery.ct b/test/commands/testdata/cnquery.ct index d08b8fa60e..b253466230 100644 --- a/test/commands/testdata/cnquery.ct +++ b/test/commands/testdata/cnquery.ct @@ -26,7 +26,7 @@ Available Commands: version Display the cnquery version Flags: - --api-proxy string Set proxy for communications with Mondoo API + --api-proxy string Set proxy for communications with Mondoo Platform API --auto-update Enable automatic provider installation and update (default true) --config string Set config file path (default $HOME/.config/mondoo/mondoo.yml) -h, --help help for cnquery diff --git a/test/commands/testdata/cnquery_providers.ct b/test/commands/testdata/cnquery_providers.ct index 93f5266bee..707adf90d3 100644 --- a/test/commands/testdata/cnquery_providers.ct +++ b/test/commands/testdata/cnquery_providers.ct @@ -1,19 +1,19 @@ $ cnquery providers --help -Manage your providers. List and install new ones or update existing ones. +Manage your providers. List and install new ones or update existing ones Usage: cnquery providers [flags] cnquery providers [command] Available Commands: - install Install or update a provider. - list List all providers on the system. + install Install or update a provider + list List all providers on the system Flags: -h, --help help for providers Global Flags: - --api-proxy string Set proxy for communications with Mondoo API + --api-proxy string Set proxy for communications with Mondoo Platform API --auto-update Enable automatic provider installation and update (default true) --config string Set config file path (default $HOME/.config/mondoo/mondoo.yml) --log-level string Set log level: error, warn, info, debug, trace (default "info") diff --git a/test/commands/testdata/cnquery_run.ct b/test/commands/testdata/cnquery_run.ct index 354722b7cf..688efdf58f 100644 --- a/test/commands/testdata/cnquery_run.ct +++ b/test/commands/testdata/cnquery_run.ct @@ -10,16 +10,16 @@ Available Commands: sbom Run a query with read SBOM file on disk Flags: - --ast Parse the query and return the abstract syntax tree (AST). - -c, --command string MQL query to executed in the shell. + --ast Parse the query and return the abstract syntax tree (AST) + -c, --command string MQL query to executed in the shell -h, --help help for run - --info Parse the query and provide information about it. - -j, --json Run the query and return the object in a JSON structure. - --parse Parse the query and return the logical structure. - --platform-id string Select a specific target asset by providing its platform ID. + --info Parse the query and provide information about it + -j, --json Run the query and return the object in a JSON structure + --parse Parse the query and return the logical structure + --platform-id string Select a specific target asset by providing its platform ID Global Flags: - --api-proxy string Set proxy for communications with Mondoo API + --api-proxy string Set proxy for communications with Mondoo Platform API --auto-update Enable automatic provider installation and update (default true) --config string Set config file path (default $HOME/.config/mondoo/mondoo.yml) --log-level string Set log level: error, warn, info, debug, trace (default "info") diff --git a/test/commands/testdata/cnquery_sbom.ct b/test/commands/testdata/cnquery_sbom.ct index 5c0ed46b25..18104df087 100644 --- a/test/commands/testdata/cnquery_sbom.ct +++ b/test/commands/testdata/cnquery_sbom.ct @@ -20,15 +20,15 @@ Available Commands: sbom Collect a software bill of materials (SBOM) for read SBOM file on disk Flags: - --annotation stringToString Add an annotation to the asset. (default []) - --asset-name string User-override for the asset name. + --annotation stringToString Add an annotation to the asset (default []) + --asset-name string User-override for the asset name -h, --help help for sbom -o, --output string Set output format: json, cyclonedx-json, cyclonedx-xml, spdx-json, spdx-tag-value, table (default "list") - --output-target string Set output target to which the sbom report will be written. + --output-target string Set output target to which the SBOM report will be written --with-evidence Display evidence for each component Global Flags: - --api-proxy string Set proxy for communications with Mondoo API + --api-proxy string Set proxy for communications with Mondoo Platform API --auto-update Enable automatic provider installation and update (default true) --config string Set config file path (default $HOME/.config/mondoo/mondoo.yml) --log-level string Set log level: error, warn, info, debug, trace (default "info") diff --git a/test/commands/testdata/cnquery_scan.ct b/test/commands/testdata/cnquery_scan.ct index aa80525494..d58403c966 100644 --- a/test/commands/testdata/cnquery_scan.ct +++ b/test/commands/testdata/cnquery_scan.ct @@ -18,24 +18,24 @@ Available Commands: sbom Scan read SBOM file on disk Flags: - --annotation stringToString Add an annotation to the asset. (default []) + --annotation stringToString Add an annotation to the asset (default []) --asset-name string User-override for the asset name - --detect-cicd Try to detect CI/CD environments. If detected, set the asset category to 'cicd'. (default true) + --detect-cicd Try to detect CI/CD environments. If detected, set the asset category to 'cicd' (default true) -h, --help help for scan - --incognito Run in incognito mode. Do not report scan results to Mondoo Platform. - --inventory-file string Set the path to the inventory file. - --inventory-format-ansible Set the inventory format to Ansible. - --inventory-format-domainlist Set the inventory format to domain list. - -j, --json Run the query and return the object in a JSON structure. + --incognito Run in incognito mode. Do not report scan results to Mondoo Platform + --inventory-file string Set the path to the inventory file + --inventory-format-ansible Set the inventory format to Ansible + --inventory-format-domainlist Set the inventory format to domain list + -j, --json Run the query and return the object in a JSON structure -o, --output string Set output format: compact, csv, full, json, json-v1, json-v2, summary, yaml (default "compact") - --platform-id string Select a specific target asset by providing its platform ID. + --platform-id string Select a specific target asset by providing its platform ID --props stringToString Custom values for properties (default []) - --querypack querypack-bundle Set the query packs to execute. This requires querypack-bundle. You can specify multiple UIDs. + --querypack querypack-bundle Set the query packs to execute. This requires querypack-bundle. You can specify multiple UIDs -f, --querypack-bundle strings Path to local query pack file --trace-id string Trace identifier Global Flags: - --api-proxy string Set proxy for communications with Mondoo API + --api-proxy string Set proxy for communications with Mondoo Platform API --auto-update Enable automatic provider installation and update (default true) --config string Set config file path (default $HOME/.config/mondoo/mondoo.yml) --log-level string Set log level: error, warn, info, debug, trace (default "info") diff --git a/test/commands/testdata/cnquery_vault.ct b/test/commands/testdata/cnquery_vault.ct index d12c2926ee..f3651a0cdf 100644 --- a/test/commands/testdata/cnquery_vault.ct +++ b/test/commands/testdata/cnquery_vault.ct @@ -12,7 +12,7 @@ Flags: -h, --help help for vault Global Flags: - --api-proxy string Set proxy for communications with Mondoo API + --api-proxy string Set proxy for communications with Mondoo Platform API --auto-update Enable automatic provider installation and update (default true) --config string Set config file path (default $HOME/.config/mondoo/mondoo.yml) --log-level string Set log level: error, warn, info, debug, trace (default "info")