/cli

A CLI for interacting with Tekton!

Primary LanguageGoApache License 2.0Apache-2.0

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

    • tektoncd-cli can be installed as a brew tap:
    brew tap tektoncd/tools
    brew install tektoncd/tools/tektoncd-cli
    # Get the tar.xz
    curl -LO https://github.com/tektoncd/cli/releases/download/v0.8.0/tkn_0.8.0_Darwin_x86_64.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.8.0_Darwin_x86_64.tar.gz -C /usr/local/bin tkn
  • Windows

    choco install tektoncd-cli --confirm
    • Or by the released zip file in the instructions below:

    • Uncompress the zip file

    • Add the location of where the executable is to your Path by opening Control Panel>System and Security>System>Advanced System Settings

    • Click on Environment Variables, select the Path variable, and click Edit

    • Click New and add the location of the uncompressed zip to the Path

    • Finish by clicking Ok

Linux tarballs

  • Linux AMD 64

    # Get the tar.xz
    curl -LO https://github.com/tektoncd/cli/releases/download/v0.8.0/tkn_0.8.0_Linux_x86_64.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.8.0_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.8.0/tkn_0.8.0_Linux_arm64.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.8.0_Linux_arm64.tar.gz -C /usr/local/bin/ tkn

Linux RPMs

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

  • Fedora30
  • Fedora31
  • Centos7
  • Centos8
  • 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

On any other RPM based distros, you can install the rpm directly:

 rpm -Uvh https://github.com/tektoncd/cli/releases/download/v0.8.0/tektoncd-cli-0.8.0_Linux-64bit.rpm

Linux Debs

If you are running on the latest Ubuntu or Debian, you would be able to use our TektonCD CLI PPA:

sudo apt update;sudo apt install -y gnupg
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3EFE0E0A2F2F60AA
echo "deb http://ppa.launchpad.net/tektoncd/cli/ubuntu eoan main"|sudo tee /etc/apt/sources.list.d/tektoncd-ubuntu-cli.list
sudo apt update && sudo apt install -y tektoncd-cli

The PPA may work with older releases, but that hasn't been tested.

On any other Debian or Ubuntu based distro, you can simply install the binary package directly with dpkg:

curl -LO https://github.com/tektoncd/cli/releases/download/v0.8.0/tektoncd-cli-0.8.0_Linux-64bit.deb
dpkg -i tektoncd-cli-0.8.0_Linux-64bit.deb

Source install

If you have go installed and you want to compile the CLI from source, you can checkout the Git repository and run the following commands:

export GO111MODULE=on
make bin/tkn

This will output the tkn binary in bin/tkn

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

Run the following to confirm tkn is available as a plugin:

$ kubectl plugin list

You should see the following after running kubectl plugin list if tkn is available as a plugin:

/usr/local/bin/kubectl-tkn

If the output above is shown, run kubectl-tkn to see the list of available tkn commands to run.

Useful Commands

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

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!