Code Monkey home page Code Monkey logo

cli's Introduction

Tekton Pipelines CLI (tkn)

Go Report Card

Tekton logo

The Tekton Pipelines CLI project provides a command-line interface (CLI) for interacting with Tekton, an open-source framework for Continuous Integration and Delivery (CI/CD) systems.

Installing tkn

Download the latest binary executable for your operating system.

Mac OS X

  brew install tektoncd-cli
  • Use released tarball

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

Windows

choco install tektoncd-cli --confirm
scoop install tektoncd-cli
#Create directory
New-Item -Path "$HOME/tektoncd/cli" -Type Directory
# Download file
Start-BitsTransfer -Source https://github.com/tektoncd/cli/releases/download/v0.19.0/tkn_0.19.0_Windows_x86_64.zip -Destination "$HOME/tektoncd/cli/."
# Uncompress zip file
Expand-Archive $HOME/tektoncd/cli/*.zip -DestinationPath C:\Users\Developer\tektoncd\cli\.
#Add to Windows `Environment Variables`
[Environment]::SetEnvironmentVariable("Path",$($env:Path + ";$Home\tektoncd\cli"),'User')

Linux tarballs

  • Linux AMD 64

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

    # Get the tar.gz
    curl -LO https://github.com/tektoncd/cli/releases/download/v0.19.0/tkn_0.19.0_Linux_s390x.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.19.0_Linux_s390x.tar.gz -C /usr/local/bin/ tkn
  • Linux IBM P

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

Linux RPMs

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

  • Latest Fedora and the two versions behind.
  • Centos Stream
  • EPEL
  • Latest RHEL

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.19.0/tektoncd-cli-0.19.0_Linux-64bit.rpm

Linux Debs

If you are running on the latest LTS Ubuntu or Debian, you can use the 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 focal 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.14qqq.0/tektoncd-cli-0.19.0_Linux-64bit.deb
dpkg -i tektoncd-cli-0.19.0_Linux-64bit.deb

NixOS/Nix

You can install tektoncd-cli from nixpkgs on any system that supports the nix package manager.

nix-env --install tektoncd-cli

Homebrew on Linux

You can install the latest tektoncd-cli if you are using Homebrew on Linux as for the osx version you need to simply do :

brew install tektoncd-cli

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.

Disable Color and Emojis in Output

For many tkn commands, color and emojis by default will appear in command output. tkn offers two approaches for disabling color and emojis from command output.

To remove the color and emojis from all tkn command output, set the environment variable NO_COLOR, such as shown below:

export NO_COLOR=""

More information on NO_COLOR can be found in the NO_COLOR documentation.

To remove color and emojis from the output of a single command execution, the --no-color option can be used with any command, such as in the example below:

tkn taskrun describe --no-color

Want to contribute

We are so excited to have you!

cli's People

Contributors

16yuki0702 avatar afrittoli avatar anshulvermapatel avatar barthy1 avatar bobcatfish avatar chetan-rns avatar chmouel avatar conky5 avatar danielhelfand avatar divyansh42 avatar dlorenc avatar girishramnani avatar hrishin avatar kadern0 avatar khrm avatar mattmoor avatar nikhil-thomas avatar onyiny-ang avatar pierretasci avatar piyush-garg avatar pradeepitm12 avatar pratikjagrut avatar puneetpunamiya avatar rudeigerc avatar savitaashture avatar sthaha avatar vdemeester avatar veeresharadhya avatar vinamra28 avatar waveywaves avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.