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 4 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
15 changes: 15 additions & 0 deletions cmd/argo/commands/archive/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,21 @@ func NewListCommand() *cobra.Command {
command := &cobra.Command{
Use: "list",
Short: "list workflows in the archive",
Example: `# Display all archive lists in the default format (wide) :
argo archive list

# Output in JSON format :
argo archive list -o json

# Filter list based on a specific label selector :
argo archive list -l key1=value1,key2=value2

# Fetch the list in chunks instead of all at once :
argo archive list --chunk-size 100

# Display help information for the command :
argo archive list -h
`,
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
19 changes: 19 additions & 0 deletions docs/cli/argo_archive_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@ list workflows in the archive
argo archive list [flags]
```

### Examples

```
# Display all archive lists in the default format (wide)
argo archive list

# Output in JSON format
argo archive list -o json

# Filter list based on a specific label selector
argo archive list -l key1=value1,key2=value2

# Fetch the list in chunks instead of all at once
argo archive list --chunk-size 100

# Display help information for the command
argo archive list -h
```
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved

### Options

```
Expand Down
1 change: 1 addition & 0 deletions v3
leehosu marked this conversation as resolved.
Show resolved Hide resolved
Loading