Skip to content
Open
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
1 change: 1 addition & 0 deletions docs/cmd/tkn_customrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@ Manage CustomRuns

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn customrun delete](tkn_customrun_delete.md) - Delete CustomRuns in a namespace
* [tkn customrun describe](tkn_customrun_describe.md) - Describe a CustomRun in a namespace
* [tkn customrun list](tkn_customrun_list.md) - Lists CustomRuns in a namespace

53 changes: 53 additions & 0 deletions docs/cmd/tkn_customrun_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## tkn customrun describe

Describe a CustomRun in a namespace

***Aliases**: desc*

### Usage

```
tkn customrun describe
```

### Synopsis

Describe a CustomRun in a namespace

### Examples

Describe a CustomRun of name 'foo' in namespace 'bar':

tkn customrun describe foo -n bar

or

tkn cr desc foo -n bar


### Options

```
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-F, --fzf use fzf to select a CustomRun to describe
-h, --help help for describe
-L, --last show description for last CustomRun
--limit int lists number of CustomRuns when selecting a CustomRun to describe (default 5)
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
```

### Options inherited from parent commands

```
-c, --context string name of the kubeconfig context to use (default: kubectl config current-context)
-k, --kubeconfig string kubectl config file (default: $HOME/.kube/config)
-n, --namespace string namespace to use (default: from $KUBECONFIG)
-C, --no-color disable coloring (default: false)
```

### SEE ALSO

* [tkn customrun](tkn_customrun.md) - Manage CustomRuns

102 changes: 102 additions & 0 deletions docs/man/man1/tkn-customrun-describe.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.TH "TKN\-CUSTOMRUN\-DESCRIBE" "1" "" "Auto generated by spf13/cobra" ""
.nh
.ad l


.SH NAME
.PP
tkn\-customrun\-describe \- Describe a CustomRun in a namespace


.SH SYNOPSIS
.PP
\fBtkn customrun describe\fP


.SH DESCRIPTION
.PP
Describe a CustomRun in a namespace


.SH OPTIONS
.PP
\fB\-\-allow\-missing\-template\-keys\fP[=true]
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

.PP
\fB\-F\fP, \fB\-\-fzf\fP[=false]
use fzf to select a CustomRun to describe

.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for describe

.PP
\fB\-L\fP, \fB\-\-last\fP[=false]
show description for last CustomRun

.PP
\fB\-\-limit\fP=5
lists number of CustomRuns when selecting a CustomRun to describe

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: (json, yaml, name, go\-template, go\-template\-file, template, templatefile, jsonpath, jsonpath\-as\-json, jsonpath\-file).

.PP
\fB\-\-show\-managed\-fields\fP[=false]
If true, keep the managedFields when printing objects in JSON or YAML format.

.PP
\fB\-\-template\fP=""
Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]].


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-c\fP, \fB\-\-context\fP=""
name of the kubeconfig context to use (default: kubectl config current\-context)

.PP
\fB\-k\fP, \fB\-\-kubeconfig\fP=""
kubectl config file (default: $HOME/.kube/config)

.PP
\fB\-n\fP, \fB\-\-namespace\fP=""
namespace to use (default: from $KUBECONFIG)

.PP
\fB\-C\fP, \fB\-\-no\-color\fP[=false]
disable coloring (default: false)


.SH EXAMPLE
.PP
Describe a CustomRun of name 'foo' in namespace 'bar':

.PP
.RS

.nf
tkn customrun describe foo \-n bar

.fi
.RE

.PP
or

.PP
.RS

.nf
tkn cr desc foo \-n bar

.fi
.RE


.SH SEE ALSO
.PP
\fBtkn\-customrun(1)\fP
2 changes: 1 addition & 1 deletion docs/man/man1/tkn-customrun.1
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Manage CustomRuns

.SH SEE ALSO
.PP
\fBtkn(1)\fP, \fBtkn\-customrun\-delete(1)\fP, \fBtkn\-customrun\-list(1)\fP
\fBtkn(1)\fP, \fBtkn\-customrun\-delete(1)\fP, \fBtkn\-customrun\-describe(1)\fP, \fBtkn\-customrun\-list(1)\fP
1 change: 1 addition & 0 deletions pkg/cmd/customrun/customrun.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ func Command(p cli.Params) *cobra.Command {
flags.AddTektonOptions(cmd)
cmd.AddCommand(
deleteCommand(p),
describeCommand(p),
listCommand(p),
)

Expand Down
Loading