Add examples to commands' --help output

[crenshaw-dev]

Summary

The Argo CD CLI has a lot of commands for which we provide no example in the --help output.

Motivation

Examples are awesome.

Proposal

For each item in this checklist, add an Example field. See already-checked items for inspiration.

In some cases, the code itself may provide sufficient information to write some examples. For other commands, you may have to read through the docs to find or create examples.

Note: When you open your PR, run make clidocsgen to make sure docs are updated to include your new examples!

• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd-server/commands/argocd_server.go#L74
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/util/app_test.go#L177
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd-k8s-auth/commands/argocd_k8s_auth.go#L12
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd-k8s-auth/commands/aws.go#L41
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd-k8s-auth/commands/azure.go#L26
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd-k8s-auth/commands/gcp.go#L26
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/completion.go#L197
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/relogin.go#L26
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app_actions.go#L38
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app_actions.go#L58
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app_actions.go#L136
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/logout.go#L17
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L22
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L41
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L78
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L125
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L163
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L204
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/projectwindows.go#L253
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/applicationset.go#L45
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/applicationset.go#L67 (feat: Add example to --help output for "argocd appset get" #15808)
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/applicationset.go#L116
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/applicationset.go#L187
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/applicationset.go#L230
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repocreds.go#L24
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repocreds.go#L71
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repocreds.go#L184
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repocreds.go#L231
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings_rbac.go#L75
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings_rbac.go#L101
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings_rbac.go#L208
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L153
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L292
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L344
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L410
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L460
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L506
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L539
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/settings.go#L583
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/app.go#L45
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/app.go#L70
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/app.go#L150
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/app.go#L238
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/repo.go#L28
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/repo.go#L70
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/admin.go#L44
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/cluster.go#L44
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/cluster.go#L491
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/cluster.go#L530
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/dashboard.go#L23
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/project_allowlist.go#L41
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/project.go#L25
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/project.go#L47
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/admin/project.go#L142
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/bcrypt.go#L16
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L58
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L117
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L317
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L401
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L648
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L717
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L977
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L1195
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L1330
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L1499
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L1617
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L2327
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L2381
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L2463
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L2546
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app.go#L2571
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repo.go#L25
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repo.go#L79
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repo.go#L226
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repo.go#L278
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/repo.go#L322
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app_resources.go#L33
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app_resources.go#L97
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/app_resources.go#L253
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/context.go#L21
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L43
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L84
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L223
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L288
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L361
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L466
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cluster.go#L495
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/gpg.go#L21
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/gpg.go#L42
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/gpg.go#L72
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/gpg.go#L109
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/gpg.go#L140
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cert.go#L24
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cert.go#L63
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cert.go#L147
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cert.go#L217
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/cert.go#L268
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L32
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L57
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L143
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L186
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L243
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L286
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L359
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/account.go#L397
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L39
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L88
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L118
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L151
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L189
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L239
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L276
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L320
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L365
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L411
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L486
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L563
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L603
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L646
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L811
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project.go#L848
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L29
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L56
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L93
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L140
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L176
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L225
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L290
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L341
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L389
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L424
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L469
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/project_role.go#L500
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/login.go#L46
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd/commands/root.go#L37
• https://github.com/argoproj/argo-cd/tree/a93477277/cmd/argocd-dex/commands/argocd_dex.go#L31

Note: I generated the list with this command...

find ./cmd -name '*.go' -print | xargs grep -n -r '&cobra.Command{' | sed "s/^./- [ ] https:\/\/github.com\/argoproj\/argo-cd\/tree\/$(git rev-parse --short HEAD)/" | sed 's/\.go:/\.go#L/' | awk -F: '{print $1":"$2}' | pbcopy

[rohitkbc]

Hi 👋 @crenshaw-dev, Can I work on some of these items?

[Ratangulati]

Hi 👋 @crenshaw-dev, I would like to work on some of these.

[crenshaw-dev]

@rohitkbc and @Ratangulati go for it! Anyone is welcome to pick this up and run with it. Just remember to do what @dttung2905 did, and mention this issue in your PR. :-)

[mcaci]

Hi all, I'd like to contribute to this issue and I created a small PR to understand if I got every step correctly (not only the change but also the steps to do the contribution). I hope it helps!

[sagarwala]

@crenshaw-dev I have picked the example for context command and added a PR. Please review. Thank you!

[kokikathir]

Hi @crenshaw-dev I have added examples for "app action" command in PR #15822.

[chiranjeevir-git]

Hi @crenshaw-dev i have added example for "argocd relogin" command in PR #15823
please review, Thank you !.

[chiranjeevir-git]

Hi @crenshaw-dev i have added example for "argocd relogin" command in a new PR #15839
Closed the old PR #15823
please review, Thank you !.

[range123]

Hey @crenshaw-dev, I've raised a PR for adding an example for generate-allow-list, please take a look. Thank you!
#16136