About Tekton CLI

With the Tekton Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands.

Installing the CLI

In order to interact with Tekton from a terminal, you need to install the Tekton CLI (tkn).

Installing from binary

For macOS X

  1. Get the tar.xz:

    curl -LO https://github.com/tektoncd/cli/releases/download/v0.2.2/tkn_0.2.2_Darwin_x86_64.tar.gz

  2. Extract tkn to your PATH:

    sudo tar xvzf tkn_0.2.2_Darwin_x86_64.tar.gz -C /usr/local/bin tkn

For Linux AMD64

  1. Get the tar.xz:

    curl -LO https://github.com/tektoncd/cli/releases/download/v0.2.2/tkn_0.2.2_Linux_x86_64.tar.gz

  2. Extract tkn to your PATH:

    sudo tar xvzf tkn_0.2.2_Linux_x86_64.tar.gz -C /usr/local/bin/ tkn

For Linux ARM64

  1. Get the tar.xz:

    curl -LO https://github.com/tektoncd/cli/releases/download/v0.2.2/tkn_0.2.2_Linux_arm64.tar.gz

  2. Extract tkn to your PATH:

    sudo tar xvzf tkn_0.2.2_Linux_arm64.tar.gz -C /usr/local/bin/ tkn

Installing with Go language

You should have Go language installed and the go environment set up correctly.

To install Tekton CLI with Go, run:

GO111MODULE="on" go get github.com/tektoncd/cli@v0.2.2

Basic Tekton CLI commands

This section lists basic Tekton CLI commands. For a more detailed desciption, see Tekton Pipelines CLI.

Syntax

tkn [command or options] [arguments…​]

Global Options

--help, -h

Utility commands

tkn

Parent command for Tekton CLI.

tkn completion

Prints shell completion scripts.

tkn version

Prints version information.

Managing and running pipelines

tkn pipeline

Manages pipelines.

tkn pipeline describe

Describes a pipeline in a namespace.

tkn pipeline list

Lists pipelines in a namespace.

tkn pipeline logs

Shows pipeline logs.

tkn pipeline start

Starts pipelines.

tkn pipelinerun

Manages pipelineruns.

tkn pipelinerun describe

Describes a pipelinerun in a namespace.

tkn pipelinerun list

Lists pipelineruns in a namespace.

tkn pipelinerun logs

Shows pipelinerun logs.

Managing pipeline resources

tkn resource

Manages pipeline resources.

tkn resource describe

Describes a pipeline resource in a namespace.

tkn resource list

Lists pipeline resources in a namespace.

Managing and running tasks

tkn task

Manages tasks.

tkn task list

Lists tasks in a namespace.

tkn taskrun

Manages taskruns.

tkn taskrun list

Lists taskruns in a namespace.

tkn taskrun logs

Shows taskruns logs.

Managing clusters

tkn clustertask

Manages clustertasks.

tkn clustertask list

Lists clusrertasks in a namespace.