docs: Add an example field to argo list command. Fixes #11898 (#12076)

Signed-off-by: Krunal Parmar <[email protected]>
(cherry picked from commit ce60013)

cmd/argo/commands/list.go

@@ -64,6 +64,34 @@ func NewListCommand() *cobra.Command {
  command := &cobra.Command{
  Use: "list",
  Short: "list workflows",
+ Example: `# List all workflows:
+ argo list
+
+# List all workflows from all namespaces:
+ argo list -A
+
+# List all running workflows:
+ argo list --running
+
+# List all completed workflows:
+ argo list --completed
+
+ # List workflows created within the last 10m:
+ argo list --since 10m
+
+# List workflows that finished more than 2h ago:
+ argo list --older 2h
+
+# List workflows with more information (such as parameters):
+ argo list -o wide
+
+# List workflows in YAML format:
+ argo list -o yaml
+
+# List workflows that have both labels:
+ argo list -l label1=value1,label2=value2
+`,
+
  Run: func(cmd *cobra.Command, args []string) {
  ctx, apiClient := client.NewAPIClient(cmd.Context())
  serviceClient := apiClient.NewWorkflowServiceClient()

docs/cli/argo_list.md

@@ -6,6 +6,38 @@ list workflows
 argo list [flags]
 ```
 
+### Examples
+
+```
+# List all workflows:
+ argo list
+
+# List all workflows from all namespaces:
+ argo list -A
+
+# List all running workflows:
+ argo list --running
+
+# List all completed workflows:
+ argo list --completed
+
+ # List workflows created within the last 10m:
+ argo list --since 10m
+
+# List workflows that finished more than 2h ago:
+ argo list --older 2h
+
+# List workflows with more information (such as parameters):
+ argo list -o wide
+
+# List workflows in YAML format:
+ argo list -o yaml
+
+# List workflows that have both labels:
+ argo list -l label1=value1,label2=value2
+
+```
+
 ### Options
 
 ```