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(cli): add examples for argo archive list with option explanations #13662

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 all archived workflows:
argo archive list

# List all archived workflows fetched in chunks of 100:
argo archive list --chunk-size 100

# List all archived workflows in YAML format:
argo archive list -o yaml

# List archived workflows that have both labels:
argo archive list -l key1=value1,key2=value2
`,
leehosu marked this conversation as resolved.
Show resolved Hide resolved
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 all archived workflows:
argo archive list

# List all archived workflows fetched in chunks of 100:
argo archive list --chunk-size 100

# List all archived workflows in YAML format:
argo archive list -o yaml

# List archived workflows that have both labels:
argo archive list -l key1=value1,key2=value2

```
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved

### Options

```
Expand Down
Loading