Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add an example field to argo archive list command. Fixes #11898 #12110

Closed
12 changes: 12 additions & 0 deletions cmd/argo/commands/archive/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ func NewListCommand() *cobra.Command {
command := &cobra.Command{
Use: "list",
Short: "list workflows in the archive",
Example: `# List Archived Workflows:
argo archive list

# List Archived Workflows in YAML format:
argo archive list --output yaml

# List Archived Workflows with a specific chunk size:
argo archive list --chunk-size <chunk_size>
shubhamch71 marked this conversation as resolved.
Show resolved Hide resolved

# List Archived Workflows with a label selector:
argo archive list -l "key1=value1,key2=value2"
`,
Run: func(cmd *cobra.Command, args []string) {
ctx, apiClient := client.NewAPIClient(cmd.Context())
serviceClient, err := apiClient.NewArchivedWorkflowServiceClient()
Expand Down
17 changes: 17 additions & 0 deletions docs/cli/argo_archive_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@ list workflows in the archive
argo archive list [flags]
```

### Examples

```
# List Archived Workflows:
argo archive list

# List Archived Workflows in YAML format:
argo archive list --output yaml

# List Archived Workflows with a specific chunk size:
argo archive list --chunk-size <chunk_size>

# List Archived Workflows with a label selector:
argo archive list -l <label_selector>

```

### Options

```
Expand Down
Loading