Skip to content
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ The following commands help you understand and effectively use the Tekton CLI:
* [`tkn completion:`](docs/cmd/tkn_completion.md) Outputs a BASH or ZSH completion script for `tkn` to allow command completion with Tab.
* [`tkn condition:`](docs/cmd/tkn_condition.md) Parent command of the Condition command group.
* [`tkn eventlistener:`](docs/cmd/tkn_eventlistener.md) Parent command of the Eventlistener command group.
* [`tkn hub:`](docs/cmd/tkn_hub.md) Search and install Tekton Resources from [Hub](https://hub-preview.tekton.dev)
* [`tkn pipeline:`](docs/cmd/tkn_pipeline.md) Parent command of the Pipeline command group.
* [`tkn pipelinerun:`](docs/cmd/tkn_pipelinerun.md) Parent command of the Pipelinerun command group.
* [`tkn resource:`](docs/cmd/tkn_resource.md) Parent command of the Resource command group.
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/tkn.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ CLI for tekton pipelines
* [tkn completion](tkn_completion.md) - Prints shell completion scripts
* [tkn condition](tkn_condition.md) - Manage Conditions
* [tkn eventlistener](tkn_eventlistener.md) - Manage EventListeners
* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn pipeline](tkn_pipeline.md) - Manage pipelines
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns
* [tkn resource](tkn_resource.md) - Manage pipeline resources
Expand Down
27 changes: 27 additions & 0 deletions docs/cmd/tkn_hub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## tkn hub

Interact with tekton hub

### Usage

```
tkn hub
```

### Synopsis

Interact with tekton hub

### Options

```
--api-server string Hub API Server URL (default "https://api.hub.tekton.dev")
-h, --help help for hub
```

### SEE ALSO

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn hub get](tkn_hub_get.md) - Get resource manifest by its name, kind, catalog, and version
* [tkn hub search](tkn_hub_search.md) - Search resource by a combination of name, kind, and tags

34 changes: 34 additions & 0 deletions docs/cmd/tkn_hub_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## tkn hub get

Get resource manifest by its name, kind, catalog, and version

### Usage

```
tkn hub get
```

### Synopsis

Get resource manifest by its name, kind, catalog, and version

### Options

```
--from string Name of Catalog to which resource belongs to. (default "tekton")
-h, --help help for get
--version string Version of Resource
```

### Options inherited from parent commands

```
--api-server string Hub API Server URL (default "https://api.hub.tekton.dev")
```

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub get pipeline](tkn_hub_get_pipeline.md) - Get pipeline by name, catalog and version
* [tkn hub get task](tkn_hub_get_task.md) - Get task by name, catalog and version

46 changes: 46 additions & 0 deletions docs/cmd/tkn_hub_get_pipeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## tkn hub get pipeline

Get pipeline by name, catalog and version
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: This should be Pipeline (see #605).


### Usage

```
tkn hub get pipeline
```

### Synopsis

Get pipeline by name, catalog and version

### Examples


Get a pipeline of name 'foo':

tkn hub get pipeline foo

or

Get a pipeline of name 'foo' of version '0.3':

tkn hub get pipeline foo --version 0.3


### Options

```
-h, --help help for pipeline
```

### Options inherited from parent commands

```
--api-server string Hub API Server URL (default "https://api.hub.tekton.dev")
--from string Name of Catalog to which resource belongs to. (default "tekton")
--version string Version of Resource
```

### SEE ALSO

* [tkn hub get](tkn_hub_get.md) - Get resource manifest by its name, kind, catalog, and version

46 changes: 46 additions & 0 deletions docs/cmd/tkn_hub_get_task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## tkn hub get task

Get task by name, catalog and version
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: This should be Task (see #605)


### Usage

```
tkn hub get task
```

### Synopsis

Get task by name, catalog and version

### Examples


Get a task of name 'foo':

tkn hub get task foo

or

Get a task of name 'foo' of version '0.3':

tkn hub get task foo --version 0.3


### Options

```
-h, --help help for task
```

### Options inherited from parent commands

```
--api-server string Hub API Server URL (default "https://api.hub.tekton.dev")
--from string Name of Catalog to which resource belongs to. (default "tekton")
--version string Version of Resource
```

### SEE ALSO

* [tkn hub get](tkn_hub_get.md) - Get resource manifest by its name, kind, catalog, and version

49 changes: 49 additions & 0 deletions docs/cmd/tkn_hub_search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## tkn hub search
Comment thread
sthaha marked this conversation as resolved.
Outdated

Search resource by a combination of name, kind, and tags

### Usage

```
tkn hub search
```

### Synopsis

Search resource by a combination of name, kind, and tags

### Examples


Search a resource of name 'foo':

tkn hub search foo

or

Search resources using tag 'cli':

tkn hub search --tags cli


### Options

```
-h, --help help for search
--kinds stringArray Accepts a comma separated list of kinds
-l, --limit uint Max number of resources to fetch
--match string Accept type of search. 'exact' or 'contains'. (default "contains")
-o, --output string Accepts output format: [table, json] (default "table")
--tags stringArray Accepts a comma separated list of tags
```

### Options inherited from parent commands

```
--api-server string Hub API Server URL (default "https://api.hub.tekton.dev")
```

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub

73 changes: 73 additions & 0 deletions docs/man/man1/tkn-hub-get-pipeline.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
.TH "TKN\-HUB\-GET\-PIPELINE" "1" "" "Auto generated by spf13/cobra" ""
.nh
.ad l


.SH NAME
.PP
tkn\-hub\-get\-pipeline \- Get pipeline by name, catalog and version


.SH SYNOPSIS
.PP
\fBtkn hub get pipeline\fP


.SH DESCRIPTION
.PP
Get pipeline by name, catalog and version


.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for pipeline


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-server\fP="
\[la]https://api.hub.tekton.dev"\[ra]
Hub API Server URL

.PP
\fB\-\-from\fP="tekton"
Name of Catalog to which resource belongs to.

.PP
\fB\-\-version\fP=""
Version of Resource


.SH EXAMPLE
.PP
Get a pipeline of name 'foo':

.PP
.RS

.nf
tkn hub get pipeline foo

.fi
.RE

.PP
or

.PP
Get a pipeline of name 'foo' of version '0.3':

.PP
.RS

.nf
tkn hub get pipeline foo \-\-version 0.3

.fi
.RE


.SH SEE ALSO
.PP
\fBtkn\-hub\-get(1)\fP
73 changes: 73 additions & 0 deletions docs/man/man1/tkn-hub-get-task.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
.TH "TKN\-HUB\-GET\-TASK" "1" "" "Auto generated by spf13/cobra" ""
.nh
.ad l


.SH NAME
.PP
tkn\-hub\-get\-task \- Get task by name, catalog and version


.SH SYNOPSIS
.PP
\fBtkn hub get task\fP


.SH DESCRIPTION
.PP
Get task by name, catalog and version


.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for task


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-server\fP="
\[la]https://api.hub.tekton.dev"\[ra]
Hub API Server URL

.PP
\fB\-\-from\fP="tekton"
Name of Catalog to which resource belongs to.

.PP
\fB\-\-version\fP=""
Version of Resource


.SH EXAMPLE
.PP
Get a task of name 'foo':

.PP
.RS

.nf
tkn hub get task foo

.fi
.RE

.PP
or

.PP
Get a task of name 'foo' of version '0.3':

.PP
.RS

.nf
tkn hub get task foo \-\-version 0.3

.fi
.RE


.SH SEE ALSO
.PP
\fBtkn\-hub\-get(1)\fP
Loading