Skip to content

feat: add structured JSON/YAML output for list commands #3242

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.

Sign up for GitHub

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

Open
arvindk-softwaredev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add structured JSON/YAML output for list commands #3242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/cmd/tkn_clustertriggerbinding_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn ctb ls

List ClusterTriggerBindings as a JSON array:

tkn clustertriggerbinding list -o json

List ClusterTriggerBindings as a YAML array:

tkn clustertriggerbinding list -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_customrun_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ List all CustomRuns in namespace 'bar':

tkn cr list -n bar

List CustomRuns as a JSON array:

tkn customrun list -o json

List CustomRuns as a YAML array:

tkn customrun list -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_eventlistener_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn el ls -n bar

List EventListeners as a JSON array:

tkn eventlistener list -o json

List EventListeners as a YAML array:

tkn eventlistener list -o yaml


### Options

Expand Down
15 changes: 15 additions & 0 deletions docs/cmd/tkn_pipeline_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ tkn pipeline list

Lists Pipelines in a namespace

### Examples

List Pipelines in namespace 'bar':

tkn pipeline list -n bar

List Pipelines as a JSON array:

tkn pipeline list -o json

List Pipelines as a YAML array:

tkn pipeline list -o yaml


### Options

```
Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_pipelinerun_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ List all PipelineRuns in a namespace 'foo':

tkn pr list -n foo

List PipelineRuns as a JSON array:

tkn pipelinerun list -o json

List PipelineRuns as a YAML array:

tkn pipelinerun list -o yaml


### Options

Expand Down
15 changes: 15 additions & 0 deletions docs/cmd/tkn_task_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ tkn task list

Lists Tasks in a namespace

### Examples

List Tasks in namespace 'bar':

tkn task list -n bar

List Tasks as a JSON array:

tkn task list -o json

List Tasks as a YAML array:

tkn task list -o yaml


### Options

```
Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_taskrun_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ List all TaskRuns of Task 'foo' in namespace 'bar':

tkn taskrun list foo -n bar

List TaskRuns as a JSON array:

tkn taskrun list -o json

List TaskRuns as a YAML array:

tkn taskrun list -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_triggerbinding_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn tb ls -n bar

List TriggerBindings as a JSON array:

tkn triggerbinding list -o json

List TriggerBindings as a YAML array:

tkn triggerbinding list -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_triggertemplate_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn tt ls -n bar

List TriggerTemplates as a JSON array:

tkn triggertemplate list -o json

List TriggerTemplates as a YAML array:

tkn triggertemplate list -o yaml


### Options

Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-clustertriggerbinding-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,30 @@ tkn ctb ls
.fi
.RE

.PP
List ClusterTriggerBindings as a JSON array:

.PP
.RS

.nf
tkn clustertriggerbinding list \-o json

.fi
.RE

.PP
List ClusterTriggerBindings as a YAML array:

.PP
.RS

.nf
tkn clustertriggerbinding list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-customrun-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,30 @@ tkn cr list \-n bar
.fi
.RE

.PP
List CustomRuns as a JSON array:

.PP
.RS

.nf
tkn customrun list \-o json

.fi
.RE

.PP
List CustomRuns as a YAML array:

.PP
.RS

.nf
tkn customrun list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-eventlistener-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,30 @@ tkn el ls \-n bar
.fi
.RE

.PP
List EventListeners as a JSON array:

.PP
.RS

.nf
tkn eventlistener list \-o json

.fi
.RE

.PP
List EventListeners as a YAML array:

.PP
.RS

.nf
tkn eventlistener list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
38 changes: 38 additions & 0 deletions docs/man/man1/tkn-pipeline-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,44 @@ Lists Pipelines in a namespace
disable coloring (default: false)


.SH EXAMPLE
.PP
List Pipelines in namespace 'bar':

.PP
.RS

.nf
tkn pipeline list \-n bar

.fi
.RE

.PP
List Pipelines as a JSON array:

.PP
.RS

.nf
tkn pipeline list \-o json

.fi
.RE

.PP
List Pipelines as a YAML array:

.PP
.RS

.nf
tkn pipeline list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
\fBtkn\-pipeline(1)\fP
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-pipelinerun-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,30 @@ tkn pr list \-n foo
.fi
.RE

.PP
List PipelineRuns as a JSON array:

.PP
.RS

.nf
tkn pipelinerun list \-o json

.fi
.RE

.PP
List PipelineRuns as a YAML array:

.PP
.RS

.nf
tkn pipelinerun list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
38 changes: 38 additions & 0 deletions docs/man/man1/tkn-task-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,44 @@ Lists Tasks in a namespace
disable coloring (default: false)


.SH EXAMPLE
.PP
List Tasks in namespace 'bar':

.PP
.RS

.nf
tkn task list \-n bar

.fi
.RE

.PP
List Tasks as a JSON array:

.PP
.RS

.nf
tkn task list \-o json

.fi
.RE

.PP
List Tasks as a YAML array:

.PP
.RS

.nf
tkn task list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
\fBtkn\-task(1)\fP
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-taskrun-list.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,30 @@ tkn taskrun list foo \-n bar
.fi
.RE

.PP
List TaskRuns as a JSON array:

.PP
.RS

.nf
tkn taskrun list \-o json

.fi
.RE

.PP
List TaskRuns as a YAML array:

.PP
.RS

.nf
tkn taskrun list \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
Loading
Loading