Skip to content

Latest commit

 

History

History
107 lines (78 loc) · 3.86 KB

README.md

File metadata and controls

107 lines (78 loc) · 3.86 KB
Raw

Tekton Pipelines cli

Go Report Card

The Tekton Pipelines cli project provides a CLI for interacting with Tekton!

Getting Started

Installing tkn

Download the latest binary executable for your operating system:

  • Mac OS X

    # Get the tar.xz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.3.1/tkn_0.3.1_Darwin_x86_64.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.3.1_Darwin_x86_64.tar.gz -C /usr/local/bin tkn

    You can also use @chmouel's unofficial brew tap for the time being.

    brew tap chmouel/tektoncd-cli
brew install tektoncd-cli

  • Linux AMD 64

    # Get the tar.xz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.3.1/tkn_0.3.1_Linux_x86_64.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.3.1_Linux_x86_64.tar.gz -C /usr/local/bin/ tkn

  • Linux ARM 64

    # Get the tar.xz
curl -LO https://github.com/tektoncd/cli/releases/download/v0.3.1/tkn_0.3.1_Linux_arm64.tar.gz
# Extract tkn to your PATH (e.g. /usr/local/bin)
sudo tar xvzf tkn_0.3.1_Linux_arm64.tar.gz -C /usr/local/bin/ tkn

    If you are running on any of the following rpm based distros:

    • Fedora30
    • Fedora31
    • Centos7
    • EPEL
    • RHEL8

    you would be able to use @chmouel's unofficial copr package repository by running the following commands:

    dnf copr enable chmouel/tektoncd-cli
dnf install tektoncd-cli

If you have go installed, GO111MODULE="on" go get github.com/tektoncd/cli@v0.3.1 is all you need!

tkn as a kubectl plugin

kubectl will find any binary named kubectl-* on your PATH and consider it as a plugin. After installing tkn, create a link as kubectl-tkn

$ ln -s /usr/local/bin/tkn /usr/local/bin/kubectl-tkn

kubectl will find any binary named kubectl-* on your PATH and consider it as a plugin

$ ./kubectl plugin list
/usr/local/bin/kubectl-tkn

Useful Commands

The following commands help you understand and effectively use the Tekton CLI:

  • tkn help: Displays a list of the commands with helpful information.
  • tkn completion: Outputs a BASH or ZSH completion script for tkn to allow command completion with Tab.
  • tkn version: Outputs the cli version.
  • tkn pipeline: Parent command of the Pipeline command group.
  • tkn pipelinerun: Parent command of the Pipelinerun command group.
  • tkn task: Parent command of the Task command group.
  • tkn taskrun: Parent command of the Taskrun command group.
  • tkn clustertask: Parent command of the ClusterTask command group.
  • tkn resource: Parent command of the Resource command group.

For every tkn command, you can use -h or --help flags to display specific help for that command.

Want to contribute

We are so excited to have you!