Skip to content
/ cli Public
forked from tektoncd/cli

A CLI for interacting with Tekton!

License

Notifications You must be signed in to change notification settings

dgozalo/cli

 
 

Repository files navigation

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.2.0/tkn_0.2.0_Darwin_x86_64.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.2.0_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.2.0/tkn_0.2.0_Linux_x86_64.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.2.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.2.0/tkn_0.2.0_Linux_arm64.tar.gz
    # Extract tkn to your PATH (e.g. /usr/local/bin)
    sudo tar xvzf tkn_0.2.0_Linux_arm64.tar.gz -C /usr/local/bin/ tkn

If you have go installed, GO111MODULE="on" go get github.com/tektoncd/cli@v0.2.0 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 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.

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!

About

A CLI for interacting with Tekton!

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 93.6%
  • Shell 5.7%
  • Makefile 0.7%