diff --git a/Makefile b/Makefile index 600166fa70..9db9273d66 100644 --- a/Makefile +++ b/Makefile @@ -414,7 +414,7 @@ lr/docs/markdown: providers/lr --output ../docs/docs/mql/resources/arista-pack ./lr markdown providers/atlassian/resources/atlassian.lr \ --pack-name "Atlassian" \ - --description "The Atlassian resource pack lets you use MQL to query and assess the security of your Atlassian Cloud services." \ + --description "The Atlassian resource pack lets you use MQL to query and assess the security of your Atlassian services." \ --docs-file providers/atlassian/resources/atlassian.lr.manifest.yaml \ --output ../docs/docs/mql/resources/atlassian-pack ./lr markdown providers/aws/resources/aws.lr \ diff --git a/providers/arista/config/config.go b/providers/arista/config/config.go index c69b8098f5..5ac0d3af5a 100644 --- a/providers/arista/config/config.go +++ b/providers/arista/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "arista", Use: "arista user@host", - Short: "Arista EOS", + Short: "an Arista EOS device", Discovery: []string{}, MinArgs: 1, MaxArgs: 1, diff --git a/providers/atlassian/config/config.go b/providers/atlassian/config/config.go index 7e6542417c..dd2fa79681 100644 --- a/providers/atlassian/config/config.go +++ b/providers/atlassian/config/config.go @@ -23,7 +23,7 @@ var Config = plugin.Provider{ { Name: "atlassian", Use: "atlassian", - Short: "atlassian", + Short: "Atlassian", MaxArgs: 2, Discovery: []string{}, Flags: []plugin.Flag{ @@ -31,31 +31,31 @@ var Config = plugin.Provider{ Long: "admin-token", Type: plugin.FlagType_String, Default: "", - Desc: "Provide atlassian admin api token (used for atlassian admin).", + Desc: "Provide 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: "Provide 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: "Provide 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: "Provide 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: "Provide Atlassian scim api token (used for scim).", }, }, }, diff --git a/providers/aws/config/config.go b/providers/aws/config/config.go index 51a53a4e8f..588e5168d6 100644 --- a/providers/aws/config/config.go +++ b/providers/aws/config/config.go @@ -19,7 +19,7 @@ var Config = plugin.Provider{ { Name: "aws", Use: "aws", - Short: "aws account", + Short: "an AWS account", MinArgs: 0, MaxArgs: 4, Discovery: []string{ diff --git a/providers/azure/config/config.go b/providers/azure/config/config.go index 49155507e3..4cd68579fc 100644 --- a/providers/azure/config/config.go +++ b/providers/azure/config/config.go @@ -18,7 +18,7 @@ var Config = plugin.Provider{ { Name: "azure", Use: "azure", - Short: "azure", + Short: "an Azure subscription", MinArgs: 0, MaxArgs: 8, Discovery: []string{ diff --git a/providers/defaults.go b/providers/defaults.go index cb35ff98c9..dde32183cb 100644 --- a/providers/defaults.go +++ b/providers/defaults.go @@ -59,7 +59,7 @@ var DefaultProviders Providers = map[string]*Provider{ Connectors: []plugin.Connector{ { Name: "atlassian", - Short: "atlassian cloud", + Short: "Atlassian", }, }, }, diff --git a/providers/equinix/config/config.go b/providers/equinix/config/config.go index 1d5b338072..3f9ca083e6 100644 --- a/providers/equinix/config/config.go +++ b/providers/equinix/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "equinix", Use: "equinix [org ] [project ] [--token ]", - Short: "Equinix Metal", + Short: "an Equinix Metal organization", Long: `equinix is designed for querying resources within a specified project or organization on the Equinix Metal platform. diff --git a/providers/gcp/config/config.go b/providers/gcp/config/config.go index 5d4ae38c3c..576ad49042 100644 --- a/providers/gcp/config/config.go +++ b/providers/gcp/config/config.go @@ -22,7 +22,7 @@ var Config = plugin.Provider{ { Name: "gcp", Use: "gcp", - Short: "GCP Cloud", + Short: "a Google Cloud project", MaxArgs: 2, Discovery: []string{ resources.DiscoveryAll, diff --git a/providers/github/config/config.go b/providers/github/config/config.go index 94624393b2..6c80b073c4 100644 --- a/providers/github/config/config.go +++ b/providers/github/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "github", Use: "github", - Short: "GitHub", + Short: "a GitHub organization or repository", MinArgs: 2, MaxArgs: 2, Discovery: []string{}, diff --git a/providers/gitlab/config/config.go b/providers/gitlab/config/config.go index 4f2d60618c..6594613983 100644 --- a/providers/gitlab/config/config.go +++ b/providers/gitlab/config/config.go @@ -21,7 +21,7 @@ var Config = plugin.Provider{ { Name: "gitlab", Use: "gitlab", - Short: "GitLab", + Short: "a GitLab group or project", Discovery: []string{ provider.DiscoveryAuto, provider.DiscoveryGroup, diff --git a/providers/google-workspace/config/config.go b/providers/google-workspace/config/config.go index 786adf3142..d54ab482dc 100644 --- a/providers/google-workspace/config/config.go +++ b/providers/google-workspace/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "google-workspace", Use: "google-workspace [--credentials-path ] [--customer-id ] [--impersonated-user-email ]", - Short: "Google Workspace", + Short: "a Google Workspace account", Long: `google-workspace is designed for querying resources within for a Google Workspace domain. The provider requires three flags to be set: diff --git a/providers/ipmi/config/config.go b/providers/ipmi/config/config.go index 22a029822b..48bc1f5c28 100644 --- a/providers/ipmi/config/config.go +++ b/providers/ipmi/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "ipmi", Use: "ipmi user@host", - Short: "Intelligent Platform Management Interface (IPMI)", + Short: "an IPMI interface", Long: `ipmi is designed for querying resources via the Intelligent Platform Management Interface (IPMI). IPMI provides management and monitoring capabilities independently of the host system's CPU, firmware (BIOS or UEFI), and operating system. diff --git a/providers/k8s/config/config.go b/providers/k8s/config/config.go index fad40e3439..b82985e895 100644 --- a/providers/k8s/config/config.go +++ b/providers/k8s/config/config.go @@ -19,7 +19,7 @@ var Config = plugin.Provider{ Name: "k8s", Aliases: []string{"kubernetes"}, Use: "k8s (optional MANIFEST path)", - Short: "a Kubernetes cluster or local manifest file(s).", + Short: "a Kubernetes cluster or local manifest file(s)", MinArgs: 0, MaxArgs: 1, Discovery: []string{ diff --git a/providers/ms365/config/config.go b/providers/ms365/config/config.go index 2fea885500..7882a4b3dd 100644 --- a/providers/ms365/config/config.go +++ b/providers/ms365/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "ms365", Use: "ms365", - Short: "ms365", + Short: "a Microsoft 365 account", MinArgs: 0, MaxArgs: 5, Discovery: []string{}, diff --git a/providers/oci/config/config.go b/providers/oci/config/config.go index 2ac54f0be5..a8f11c5e17 100644 --- a/providers/oci/config/config.go +++ b/providers/oci/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "oci", Use: "oci", - Short: "Oracle Cloud Infrastructure", + Short: "an Oracle Cloud Infrastructure tenancy", Discovery: []string{}, Flags: []plugin.Flag{ { diff --git a/providers/opcua/config/config.go b/providers/opcua/config/config.go index 0573055282..7d105d73a7 100644 --- a/providers/opcua/config/config.go +++ b/providers/opcua/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "opcua", Use: "opcua [--endpoint ]", - Short: "OPC UA", + Short: "an OPC UA device", Long: `opcua is designed for querying resources on an OPC UA (Open Platform Communications Unified Architecture) server, a protocol facilitating machine-to-machine communications within the realm of industrial automation. diff --git a/providers/os/config/config.go b/providers/os/config/config.go index cd3b3dc71d..8f4c6d22e6 100644 --- a/providers/os/config/config.go +++ b/providers/os/config/config.go @@ -200,7 +200,7 @@ var Config = plugin.Provider{ { Name: "docker", Use: "docker", - Short: "a running docker or docker image", + Short: "a running Docker container or Docker image", MinArgs: 1, MaxArgs: 2, Discovery: []string{ @@ -234,7 +234,7 @@ var Config = plugin.Provider{ Name: "filesystem", Aliases: []string{"fs"}, Use: "filesystem [flags]", - Short: "a mounted file system target.", + Short: "a mounted file system target", MinArgs: 0, MaxArgs: 0, Flags: []plugin.Flag{ diff --git a/providers/slack/config/config.go b/providers/slack/config/config.go index 007c6bd457..957dd9df63 100644 --- a/providers/slack/config/config.go +++ b/providers/slack/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "slack", Use: "slack", - Short: "slack team", + Short: "a Slack team", MinArgs: 0, MaxArgs: 0, Discovery: []string{}, diff --git a/providers/terraform/config/config.go b/providers/terraform/config/config.go index 2f37650172..50b6c60b38 100644 --- a/providers/terraform/config/config.go +++ b/providers/terraform/config/config.go @@ -23,7 +23,7 @@ var Config = plugin.Provider{ Name: "terraform", Aliases: []string{}, Use: "terraform PATH", - Short: "a terraform hcl file or directory.", + Short: "a Terraform HCL file or directory", MinArgs: 1, MaxArgs: 2, Discovery: []string{}, diff --git a/providers/vcd/config/config.go b/providers/vcd/config/config.go index f196c93f38..1e81fbc1ed 100644 --- a/providers/vcd/config/config.go +++ b/providers/vcd/config/config.go @@ -17,7 +17,7 @@ var Config = plugin.Provider{ { Name: "vcd", Use: "vcd [--user ] [--host ] [--organization ] [--ask-pass] [--password ]", - Short: "VMware Cloud Director", + Short: "a VMware Cloud Director installation", Long: `vcd is designed for querying resources within for a VMware Cloud Director environment. VMware's vCloud Director (vCD), a platform that facilitates the operation and management of virtual resources within a multi-tenant cloud environment. diff --git a/providers/vsphere/config/config.go b/providers/vsphere/config/config.go index 726da8c5bf..a572fb6d0a 100644 --- a/providers/vsphere/config/config.go +++ b/providers/vsphere/config/config.go @@ -18,7 +18,7 @@ var Config = plugin.Provider{ { Name: "vsphere", Use: "vsphere user@host", - Short: "VMware vSphere", + Short: "a VMware vSphere installation", Discovery: []string{ resources.DiscoveryApi, resources.DiscoveryInstances,