Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Pipelines CLI (tkn) reference

Red Hat OpenShift Pipelines 1.18

The tkn CLI reference for OpenShift Pipelines

Red Hat OpenShift Documentation Team

Abstract

This document provides information about how to install, configure, and use the tkn CLI tool for OpenShift Pipelines.

Chapter 1. Installing tkn
Copy link

Use the CLI tool to manage Red Hat OpenShift Pipelines from a terminal. You can install the CLI tool on different platforms.

Note

Both the archives and the RPMs contain the following executables:

  • tkn
  • tkn-pac
  • opc
Important

Running Red Hat OpenShift Pipelines with the opc CLI tool is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

For Linux distributions, you can download the CLI as a tar.gz archive.

Procedure

  1. Download the relevant CLI tool.

  1. Unpack the archive: 

    $ tar xvzf <file>
    Copy to Clipboard Toggle word wrap
  2. Add the location of your tkn, tkn-pac, and opc files to your PATH environment variable.

  3. To check your PATH, run the following command: 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

For Red Hat Enterprise Linux (RHEL) version 8, you can install the Red Hat OpenShift Pipelines CLI as an RPM.

Prerequisites

  • You have an active OpenShift Container Platform subscription on your Red Hat account.
  • You have root or sudo privileges on your local system.

Procedure

  1. Register with Red Hat Subscription Manager: 

    # subscription-manager register
    Copy to Clipboard Toggle word wrap

  2. Pull the latest subscription data: 

    # subscription-manager refresh
    Copy to Clipboard Toggle word wrap

  3. List the available subscriptions: 

    # subscription-manager list --available --matches '*pipelines*'
    Copy to Clipboard Toggle word wrap

  4. In the output for the previous command, find the pool ID for your OpenShift Container Platform subscription and attach the subscription to the registered system: 

    # subscription-manager attach --pool=<pool_id>
    Copy to Clipboard Toggle word wrap

  5. Enable the repositories required by Red Hat OpenShift Pipelines:

    • Linux (x86_64, amd64) 

      # subscription-manager repos --enable="pipelines-1.18-for-rhel-8-x86_64-rpms"
      Copy to Clipboard Toggle word wrap

    • Linux on IBM zSystems and IBM® LinuxONE (s390x) 

      # subscription-manager repos --enable="pipelines-1.18-for-rhel-8-s390x-rpms"
      Copy to Clipboard Toggle word wrap

    • Linux on IBM Power (ppc64le) 

      # subscription-manager repos --enable="pipelines-1.18-for-rhel-8-ppc64le-rpms"
      Copy to Clipboard Toggle word wrap

    • Linux on ARM (aarch64, arm64) 

      # subscription-manager repos --enable="pipelines-1.18-for-rhel-8-aarch64-rpms"
      Copy to Clipboard Toggle word wrap

  6. Install the openshift-pipelines-client package: 

    # yum install openshift-pipelines-client
    Copy to Clipboard Toggle word wrap

After you install the CLI, it is available using the tkn command: 

$ tkn version
Copy to Clipboard Toggle word wrap

For Windows, you can download the CLI as a zip archive.

Procedure

  1. Download the CLI tool.
  2. Extract the archive with a ZIP program.
  3. Add the location of your tkn, tkn-pac, and opc files to your PATH environment variable.

  4. To check your PATH, run the following command: 

    C:\> path
    Copy to Clipboard Toggle word wrap

For macOS, you can download the CLI as a tar.gz archive.

Procedure

  1. Download the relevant CLI tool.

  2. Unpack and extract the archive.
  3. Add the location of your tkn, tkn-pac, and opc files to your PATH environment variable.

  4. To check your PATH, run the following command: 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

Configure the Red Hat OpenShift Pipelines tkn CLI to enable tab completion.

2.1. Enabling tab completion
Copy link

After you install the tkn CLI, you can enable tab completion to automatically complete tkn commands or suggest options when you press Tab.

Prerequisites

  • You must have the tkn CLI tool installed.
  • You must have bash-completion installed on your local system.

Procedure

The following procedure enables tab completion for Bash.

  1. Save the Bash completion code to a file: 

    $ tkn completion bash > tkn_bash_completion
    Copy to Clipboard Toggle word wrap

  2. Copy the file to /etc/bash_completion.d/: 

    $ sudo cp tkn_bash_completion /etc/bash_completion.d/
    Copy to Clipboard Toggle word wrap

    Alternatively, you can save the file to a local directory and source it from your .bashrc file instead.

Tab completion is enabled when you open a new terminal.

Chapter 3. OpenShift Pipelines tkn reference
Copy link

This section lists the basic tkn CLI commands.

3.1. Basic syntax
Copy link

tkn [command or options] [arguments…​]

3.2. Global options
Copy link

--help, -h

3.3. Utility commands
Copy link

3.3.1. tkn
Copy link

Parent command for tkn CLI.

Example: Display all options

$ tkn
Copy to Clipboard Toggle word wrap

3.3.2. completion [shell]
Copy link

Print shell completion code which must be evaluated to provide interactive completion. Supported shells are bash and zsh.

Example: Completion code for bash shell

$ tkn completion bash
Copy to Clipboard Toggle word wrap

3.3.3. version
Copy link

Print version information of the tkn CLI.

Example: Check the tkn version

$ tkn version
Copy to Clipboard Toggle word wrap

3.4. Pipelines management commands
Copy link

3.4.1. pipeline
Copy link

Manage pipelines.

Example: Display help

$ tkn pipeline --help
Copy to Clipboard Toggle word wrap

3.4.2. pipeline delete
Copy link

Delete a pipeline.

Example: Delete a pipeline from a namespace

$ tkn pipeline delete <pipeline_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.4.3. pipeline describe
Copy link

Describe a pipeline.

Example: Describe a pipeline

$ tkn pipeline describe <pipeline_name>
Copy to Clipboard Toggle word wrap

3.4.4. pipeline list
Copy link

Display a list of pipelines.

Example: Display a list of pipelines

$ tkn pipeline list
Copy to Clipboard Toggle word wrap

3.4.5. pipeline logs
Copy link

Display the logs for a specific pipeline.

Example: Stream the live logs for a pipeline

$ tkn pipeline logs -f <pipeline_name>
Copy to Clipboard Toggle word wrap

3.4.6. pipeline start
Copy link

Start a pipeline.

Example: Start a pipeline

$ tkn pipeline start <pipeline_name>
Copy to Clipboard Toggle word wrap

3.5. Pipeline run commands
Copy link

3.5.1. pipelinerun
Copy link

Manage pipeline runs.

Example: Display help

$ tkn pipelinerun -h
Copy to Clipboard Toggle word wrap

3.5.2. pipelinerun cancel
Copy link

Cancel a pipeline run.

Example: Cancel a pipeline run from a namespace

$ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.5.3. pipelinerun delete
Copy link

Delete a pipeline run.

Example: Delete pipeline runs from a namespace

$ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
Copy to Clipboard Toggle word wrap

Example: Delete all pipeline runs from a namespace, except the five most recently executed pipeline runs

$ tkn pipelinerun delete -n <namespace_name> --keep 5
1
Copy to Clipboard Toggle word wrap

1
Replace 5 with the number of most recently executed pipeline runs you want to retain.

Example: Delete all pipelines

$ tkn pipelinerun delete --all
Copy to Clipboard Toggle word wrap

Note

Starting with Red Hat OpenShift Pipelines 1.6, the tkn pipelinerun delete --all command does not delete any resources that are in the running state.

3.5.4. pipelinerun describe
Copy link

Describe a pipeline run.

Example: Describe a pipeline run in a namespace

$ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.5.5. pipelinerun list
Copy link

List pipeline runs.

Example: Display a list of pipeline runs in a namespace

$ tkn pipelinerun list -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.5.6. pipelinerun logs
Copy link

Display the logs of a pipeline run.

Example: Display the logs of a pipeline run with all tasks and steps in a namespace

$ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6. Task management commands
Copy link

3.6.1. task
Copy link

Manage tasks.

Example: Display help

$ tkn task -h
Copy to Clipboard Toggle word wrap

3.6.2. task delete
Copy link

Delete a task.

Example: Delete tasks from a namespace

$ tkn task delete <task_name_1> <task_name_2> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6.3. task describe
Copy link

Describe a task.

Example: Describe a task in a namespace

$ tkn task describe <task_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6.4. task list
Copy link

List tasks.

Example: List all the tasks in a namespace

$ tkn task list -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.6.5. task start
Copy link

Start a task.

Example: Start a task in a namespace

$ tkn task start <task_name> -s <service_account_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7. Task run commands
Copy link

3.7.1. taskrun
Copy link

Manage task runs.

Example: Display help

$ tkn taskrun -h
Copy to Clipboard Toggle word wrap

3.7.2. taskrun cancel
Copy link

Cancel a task run.

Example: Cancel a task run from a namespace

$ tkn taskrun cancel <task_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7.3. taskrun delete
Copy link

Delete a TaskRun.

Example: Delete task runs from a namespace

$ tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name>
Copy to Clipboard Toggle word wrap

Example: Delete all but the five most recently executed task runs from a namespace

$ tkn taskrun delete -n <namespace_name> --keep 5
1
Copy to Clipboard Toggle word wrap

1
Replace 5 with the number of most recently executed task runs you want to retain.

3.7.4. taskrun describe
Copy link

Describe a task run.

Example: Describe a task run in a namespace

$ tkn taskrun describe <task_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7.5. taskrun list
Copy link

List task runs.

Example: List all the task runs in a namespace

$ tkn taskrun list -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.7.6. taskrun logs
Copy link

Display task run logs.

Example: Display live logs for a task run in a namespace

$ tkn taskrun logs -f <task_run_name> -n <namespace_name>
Copy to Clipboard Toggle word wrap

3.8. Pipeline Resource management commands
Copy link

3.8.1. resource
Copy link

Manage Pipeline Resources.

Example: Display help

$ tkn resource -h
Copy to Clipboard Toggle word wrap

3.8.2. resource create
Copy link

Create a Pipeline Resource.

Example: Create a Pipeline Resource in a namespace

$ tkn resource create -n myspace
Copy to Clipboard Toggle word wrap

This is an interactive command that asks for input on the name of the Resource, type of the Resource, and the values based on the type of the Resource.

3.8.3. resource delete
Copy link

Delete a Pipeline Resource.

Example: Delete the myresource Pipeline Resource from a namespace

$ tkn resource delete myresource -n myspace
Copy to Clipboard Toggle word wrap

3.8.4. resource describe
Copy link

Describe a Pipeline Resource.

Example: Describe the myresource Pipeline Resource

$ tkn resource describe myresource -n myspace
Copy to Clipboard Toggle word wrap

3.8.5. resource list
Copy link

List Pipeline Resources.

Example: List all Pipeline Resources in a namespace

$ tkn resource list -n myspace
Copy to Clipboard Toggle word wrap

3.9. Trigger management commands
Copy link

3.9.1. eventlistener
Copy link

Manage EventListeners.

Example: Display help

$ tkn eventlistener -h
Copy to Clipboard Toggle word wrap

3.9.2. eventlistener delete
Copy link

Delete an EventListener.

Example: Delete mylistener1 and mylistener2 EventListeners in a namespace

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
Copy to Clipboard Toggle word wrap

3.9.3. eventlistener describe
Copy link

Describe an EventListener.

Example: Describe the mylistener EventListener in a namespace

$ tkn eventlistener describe mylistener -n myspace
Copy to Clipboard Toggle word wrap

3.9.4. eventlistener list
Copy link

List EventListeners.

Example: List all the EventListeners in a namespace

$ tkn eventlistener list -n myspace
Copy to Clipboard Toggle word wrap

3.9.5. eventlistener logs
Copy link

Display logs of an EventListener.

Example: Display the logs of the mylistener EventListener in a namespace

$ tkn eventlistener logs mylistener -n myspace
Copy to Clipboard Toggle word wrap

3.9.6. triggerbinding
Copy link

Manage TriggerBindings.

Example: Display TriggerBindings help

$ tkn triggerbinding -h
Copy to Clipboard Toggle word wrap

3.9.7. triggerbinding delete
Copy link

Delete a TriggerBinding.

Example: Delete mybinding1 and mybinding2 TriggerBindings in a namespace

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
Copy to Clipboard Toggle word wrap

3.9.8. triggerbinding describe
Copy link

Describe a TriggerBinding.

Example: Describe the mybinding TriggerBinding in a namespace

$ tkn triggerbinding describe mybinding -n myspace
Copy to Clipboard Toggle word wrap

3.9.9. triggerbinding list
Copy link

List TriggerBindings.

Example: List all the TriggerBindings in a namespace

$ tkn triggerbinding list -n myspace
Copy to Clipboard Toggle word wrap

3.9.10. triggertemplate
Copy link

Manage TriggerTemplates.

Example: Display TriggerTemplate help

$ tkn triggertemplate -h
Copy to Clipboard Toggle word wrap

3.9.11. triggertemplate delete
Copy link

Delete a TriggerTemplate.

Example: Delete mytemplate1 and mytemplate2 TriggerTemplates in a namespace

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
Copy to Clipboard Toggle word wrap

3.9.12. triggertemplate describe
Copy link

Describe a TriggerTemplate.

Example: Describe the mytemplate TriggerTemplate in a namespace

$ tkn triggertemplate describe mytemplate -n `myspace`
Copy to Clipboard Toggle word wrap

3.9.13. triggertemplate list
Copy link

List TriggerTemplates.

Example: List all the TriggerTemplates in a namespace

$ tkn triggertemplate list -n myspace
Copy to Clipboard Toggle word wrap

3.9.14. clustertriggerbinding
Copy link

Manage ClusterTriggerBindings.

Example: Display ClusterTriggerBindings help

$ tkn clustertriggerbinding -h
Copy to Clipboard Toggle word wrap

3.9.15. clustertriggerbinding delete
Copy link

Delete a ClusterTriggerBinding.

Example: Delete myclusterbinding1 and myclusterbinding2 ClusterTriggerBindings

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
Copy to Clipboard Toggle word wrap

3.9.16. clustertriggerbinding describe
Copy link

Describe a ClusterTriggerBinding.

Example: Describe the myclusterbinding ClusterTriggerBinding

$ tkn clustertriggerbinding describe myclusterbinding
Copy to Clipboard Toggle word wrap

3.9.17. clustertriggerbinding list
Copy link

List ClusterTriggerBindings.

Example: List all ClusterTriggerBindings

$ tkn clustertriggerbinding list
Copy to Clipboard Toggle word wrap

3.10. Hub interaction commands
Copy link

Interact with Tekton Hub for resources such as tasks and pipelines.

3.10.1. hub
Copy link

Interact with hub.

Example: Display help

$ tkn hub -h
Copy to Clipboard Toggle word wrap

Example: Interact with a hub API server

$ tkn hub --api-server https://api.hub.tekton.dev
Copy to Clipboard Toggle word wrap

Note

For each example, to get the corresponding sub-commands and flags, run tkn hub <command> --help.

3.10.2. hub downgrade
Copy link

Downgrade an installed resource.

Example: Downgrade the mytask task in the mynamespace namespace to it’s older version

$ tkn hub downgrade task mytask --to version -n mynamespace
Copy to Clipboard Toggle word wrap

3.10.3. hub get
Copy link

Get a resource manifest by its name, kind, catalog, and version.

Example: Get the manifest for a specific version of the myresource pipeline or task from the tekton catalog

$ tkn hub get [pipeline | task] myresource --from tekton --version version
Copy to Clipboard Toggle word wrap

3.10.4. hub info
Copy link

Display information about a resource by its name, kind, catalog, and version.

Example: Display information about a specific version of the mytask task from the tekton catalog

$ tkn hub info task mytask --from tekton --version version
Copy to Clipboard Toggle word wrap

3.10.5. hub install
Copy link

Install a resource from a catalog by its kind, name, and version.

Example: Install a specific version of the mytask task from the tekton catalog in the mynamespace namespace

$ tkn hub install task mytask --from tekton --version version -n mynamespace
Copy to Clipboard Toggle word wrap

3.10.6. hub reinstall
Copy link

Reinstall a resource by its kind and name.

Example: Reinstall a specific version of the mytask task from the tekton catalog in the mynamespace namespace

$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace
Copy to Clipboard Toggle word wrap

3.10.8. hub upgrade
Copy link

Upgrade an installed resource.

Example: Upgrade the installed mytask task in the mynamespace namespace to a new version

$ tkn hub upgrade task mytask --to version -n mynamespace
Copy to Clipboard Toggle word wrap

Legal Notice
Copy link

Copyright © 2025 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat