feat(cli): example for generate-allow-list (argoproj#16136)

Signed-off-by: Jayaraman N R <[email protected]> Signed-off-by: Jayaraman N.R <[email protected]> Co-authored-by: Jayaraman N R <[email protected]> Signed-off-by: jmilic1 <[email protected]>
jmilic1 · Nov 13, 2023 · 6fadc99 · 6fadc99
1 parent 8e244e3
commit 6fadc99
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/cmd/argocd/commands/admin/project_allowlist.go b/cmd/argocd/commands/admin/project_allowlist.go
@@ -41,6 +41,8 @@ func NewProjectAllowListGenCommand() *cobra.Command {
 	var command = &cobra.Command{
 		Use:   "generate-allow-list CLUSTERROLE_PATH PROJ_NAME",
 		Short: "Generates project allow list from the specified clusterRole file",
+		Example: `# Generates project allow list from the specified clusterRole file
+argocd admin proj generate-allow-list /path/to/clusterrole.yaml my-project`,
 		Run: func(c *cobra.Command, args []string) {
 			if len(args) != 2 {
 				c.HelpFunc()(c, args)

diff --git a/docs/user-guide/commands/argocd_admin_proj_generate-allow-list.md b/docs/user-guide/commands/argocd_admin_proj_generate-allow-list.md
@@ -8,6 +8,13 @@ Generates project allow list from the specified clusterRole file
 argocd admin proj generate-allow-list CLUSTERROLE_PATH PROJ_NAME [flags]
 ```
 
+### Examples
+
+```
+# Generates project allow list from the specified clusterRole file
+argocd admin proj generate-allow-list /path/to/clusterrole.yaml my-project
+```
+
 ### Options
 
 ```