Add examples to commands' --help output

[tico24]

Summary

The Argo 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. EDIT by agilgur5: See already-checked items for inspiration, use similar style & examples when possible, such as argo list for argo archive list, etc.

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.

--- list has been updated & modified by agilgur5 ---

argo commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cp.go#L30
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/delete.go#L27
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/get.go#L22
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/list.go#L64 -- Completed in docs(cli): add example field to argo list. Fixes #11898 #12076
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/lint.go#L26
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/logs.go#L27
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/node.go#L29
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/resubmit.go#L37
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/resume.go#L22
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/retry.go#L40
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/stop.go#L38
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/submit.go#L32
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/suspend.go#L14
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/terminate.go#L46
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/wait.go#L12
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/watch.go#L15

argo executor-plugin commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/executorplugin/build.go#L13

argo archive commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/list.go#L25 -- Completed in docs(cli): add examples for argo archive list with option explanations #13662
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/delete.go#L14 -- Completed in docs(cli): add example for argo archive delete #13675
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/resubmit.go#L39
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/retry.go#L42
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/list_label_keys.go#L14
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/get.go#L21 -- Completed in docs(cli): add examples for argo archive get with option explanations #13668
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/archive/list_label_values.go#L18

argo auth commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/auth/token.go#L13

argo template commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/template/create.go#L25
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/template/list.go#L24
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/template/delete.go#L19
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/template/lint.go#L19
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/template/get.go#L20

argo cluster-template commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/clustertemplate/create.go#L25 -- Completed in docs(cli): add example field to argo cluster-template create. Fixes #11898 #12101
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/clustertemplate/list.go#L22 -- Completed in docs(cli): add example field to argo cluster-template list. Fixes #11898 #12106
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/clustertemplate/delete.go#L18
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/clustertemplate/lint.go#L19
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/clustertemplate/get.go#L20

argo cron commands

• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/create.go#L32
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/list.go#L28
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/resume.go#L15
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/delete.go#L15
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/suspend.go#L15
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/lint.go#L19
• https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/get.go#L23

Note: I generated the list with this command which I liberated from @crenshaw-dev...

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

EDIT: list was further updated & modified by agilgur5

---

Message from the maintainers:

Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.

[Jaishree2310]

@tico24 Can you please assign this issue to me ?

[tico24]

I think the idea is that users take each one and do a PR for each. It helps with people's Hacktober stats or something.

[alok1929]

Hey, I would like to integrate this into the help : https://github.com/argoproj/argo-workflows/tree/1f66a399e/cmd/argo/commands/cron/lint.go#L19

Should I use docker to setup the dev environment or how do I do it ? Thanks in advance!!!

@tico24