From 8fafbd80ea9e723adc934f87bbbbe9e1965cd647 Mon Sep 17 00:00:00 2001 From: Letha Date: Mon, 9 Dec 2024 07:50:46 -0800 Subject: [PATCH] Add GitLab long-form help (#4966) --- providers/gitlab/config/config.go | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/providers/gitlab/config/config.go b/providers/gitlab/config/config.go index 89bf248aa..15d04cf5c 100644 --- a/providers/gitlab/config/config.go +++ b/providers/gitlab/config/config.go @@ -23,6 +23,24 @@ var Config = plugin.Provider{ Name: "gitlab", Use: "gitlab", Short: "a GitLab group or project", + Long: `Use the gitlab provider to query resources within GitLab groups and projects. + + Available commands: + group GitLab group + project GitLab project + + Examples: + cnspec scan gitlab --group --token + cnspec scan gitlab --discover projects --token + cnspec scan gitlab --group --project --token + cnspec scan gitlab --group --discover projects --token + cnspec scan gitlab --discover terraform --token + cnquery shell gitlab --group --token + cnquery shell gitlab --group --project --token + + Notes: + Mondoo needs a personal access token to scan a GitHub group or project. The token's level of access determines how much information Mondoo can retrieve. Instead of providing a token with every command, you can supply your personal access token to Mondoo by setting the GITLAB_TOKEN environment variable. To learn how, read https://mondoo.com/docs/cnspec/saas/gitlab/. + `, Discovery: []string{ provider.DiscoveryGroup, provider.DiscoveryProject,