Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 3. OpenShift Pipelines tkn reference

This section lists the basic tkn CLI commands.

3.1. Basic syntax

tkn [command or options] [arguments…​]

3.2. Global options

--help, -h

3.3. Utility commands

3.3.1. tkn

Parent command for tkn CLI.

Example: Display all options

$ tkn
Copy to Clipboard

3.3.2. completion [shell]

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

3.3.3. version

Print version information of the tkn CLI.

Example: Check the tkn version

$ tkn version
Copy to Clipboard

3.4. Pipelines management commands

3.4.1. pipeline

Manage pipelines.

Example: Display help

$ tkn pipeline --help
Copy to Clipboard

3.4.2. pipeline delete

Delete a pipeline.

Example: Delete a pipeline from a namespace

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

3.4.3. pipeline describe

Describe a pipeline.

Example: Describe a pipeline

$ tkn pipeline describe <pipeline_name>
Copy to Clipboard

3.4.4. pipeline list

Display a list of pipelines.

Example: Display a list of pipelines

$ tkn pipeline list
Copy to Clipboard

3.4.5. pipeline logs

Display the logs for a specific pipeline.

Example: Stream the live logs for a pipeline

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

3.4.6. pipeline start

Start a pipeline.

Example: Start a pipeline

$ tkn pipeline start <pipeline_name>
Copy to Clipboard

3.5. Pipeline run commands

3.5.1. pipelinerun

Manage pipeline runs.

Example: Display help

$ tkn pipelinerun -h
Copy to Clipboard

3.5.2. pipelinerun cancel

Cancel a pipeline run.

Example: Cancel a pipeline run from a namespace

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

3.5.3. pipelinerun delete

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

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

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

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

Describe a pipeline run.

Example: Describe a pipeline run in a namespace

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

3.5.5. pipelinerun list

List pipeline runs.

Example: Display a list of pipeline runs in a namespace

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

3.5.6. pipelinerun logs

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

3.6. Task management commands

3.6.1. task

Manage tasks.

Example: Display help

$ tkn task -h
Copy to Clipboard

3.6.2. task delete

Delete a task.

Example: Delete tasks from a namespace

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

3.6.3. task describe

Describe a task.

Example: Describe a task in a namespace

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

3.6.4. task list

List tasks.

Example: List all the tasks in a namespace

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

3.6.5. task start

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

3.7. Task run commands

3.7.1. taskrun

Manage task runs.

Example: Display help

$ tkn taskrun -h
Copy to Clipboard

3.7.2. taskrun cancel

Cancel a task run.

Example: Cancel a task run from a namespace

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

3.7.3. taskrun delete

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

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

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

3.7.4. taskrun describe

Describe a task run.

Example: Describe a task run in a namespace

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

3.7.5. taskrun list

List task runs.

Example: List all the task runs in a namespace

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

3.7.6. taskrun logs

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

3.8. Pipeline Resource management commands

3.8.1. resource

Manage Pipeline Resources.

Example: Display help

$ tkn resource -h
Copy to Clipboard

3.8.2. resource create

Create a Pipeline Resource.

Example: Create a Pipeline Resource in a namespace

$ tkn resource create -n myspace
Copy to Clipboard

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

Delete a Pipeline Resource.

Example: Delete the myresource Pipeline Resource from a namespace

$ tkn resource delete myresource -n myspace
Copy to Clipboard

3.8.4. resource describe

Describe a Pipeline Resource.

Example: Describe the myresource Pipeline Resource

$ tkn resource describe myresource -n myspace
Copy to Clipboard

3.8.5. resource list

List Pipeline Resources.

Example: List all Pipeline Resources in a namespace

$ tkn resource list -n myspace
Copy to Clipboard

3.9. ClusterTask management commands

Important

In Red Hat OpenShift Pipelines 1.10, ClusterTask functionality of the tkn command line utility is deprecated and is planned to be removed in a future release.

3.9.1. clustertask

Manage ClusterTasks.

Example: Display help

$ tkn clustertask --help
Copy to Clipboard

3.9.2. clustertask delete

Delete a ClusterTask resource in a cluster.

Example: Delete mytask1 and mytask2 ClusterTasks

$ tkn clustertask delete mytask1 mytask2
Copy to Clipboard

3.9.3. clustertask describe

Describe a ClusterTask.

Example: Describe the mytask ClusterTask

$ tkn clustertask describe mytask1
Copy to Clipboard

3.9.4. clustertask list

List ClusterTasks.

Example: List ClusterTasks

$ tkn clustertask list
Copy to Clipboard

3.9.5. clustertask start

Start ClusterTasks.

Example: Start the mytask ClusterTask

$ tkn clustertask start mytask
Copy to Clipboard

3.10. Trigger management commands

3.10.1. eventlistener

Manage EventListeners.

Example: Display help

$ tkn eventlistener -h
Copy to Clipboard

3.10.2. eventlistener delete

Delete an EventListener.

Example: Delete mylistener1 and mylistener2 EventListeners in a namespace

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

3.10.3. eventlistener describe

Describe an EventListener.

Example: Describe the mylistener EventListener in a namespace

$ tkn eventlistener describe mylistener -n myspace
Copy to Clipboard

3.10.4. eventlistener list

List EventListeners.

Example: List all the EventListeners in a namespace

$ tkn eventlistener list -n myspace
Copy to Clipboard

3.10.5. eventlistener logs

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

3.10.6. triggerbinding

Manage TriggerBindings.

Example: Display TriggerBindings help

$ tkn triggerbinding -h
Copy to Clipboard

3.10.7. triggerbinding delete

Delete a TriggerBinding.

Example: Delete mybinding1 and mybinding2 TriggerBindings in a namespace

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

3.10.8. triggerbinding describe

Describe a TriggerBinding.

Example: Describe the mybinding TriggerBinding in a namespace

$ tkn triggerbinding describe mybinding -n myspace
Copy to Clipboard

3.10.9. triggerbinding list

List TriggerBindings.

Example: List all the TriggerBindings in a namespace

$ tkn triggerbinding list -n myspace
Copy to Clipboard

3.10.10. triggertemplate

Manage TriggerTemplates.

Example: Display TriggerTemplate help

$ tkn triggertemplate -h
Copy to Clipboard

3.10.11. triggertemplate delete

Delete a TriggerTemplate.

Example: Delete mytemplate1 and mytemplate2 TriggerTemplates in a namespace

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

3.10.12. triggertemplate describe

Describe a TriggerTemplate.

Example: Describe the mytemplate TriggerTemplate in a namespace

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

3.10.13. triggertemplate list

List TriggerTemplates.

Example: List all the TriggerTemplates in a namespace

$ tkn triggertemplate list -n myspace
Copy to Clipboard

3.10.14. clustertriggerbinding

Manage ClusterTriggerBindings.

Example: Display ClusterTriggerBindings help

$ tkn clustertriggerbinding -h
Copy to Clipboard

3.10.15. clustertriggerbinding delete

Delete a ClusterTriggerBinding.

Example: Delete myclusterbinding1 and myclusterbinding2 ClusterTriggerBindings

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
Copy to Clipboard

3.10.16. clustertriggerbinding describe

Describe a ClusterTriggerBinding.

Example: Describe the myclusterbinding ClusterTriggerBinding

$ tkn clustertriggerbinding describe myclusterbinding
Copy to Clipboard

3.10.17. clustertriggerbinding list

List ClusterTriggerBindings.

Example: List all ClusterTriggerBindings

$ tkn clustertriggerbinding list
Copy to Clipboard

3.11. Hub interaction commands

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

3.11.1. hub

Interact with hub.

Example: Display help

$ tkn hub -h
Copy to Clipboard

Example: Interact with a hub API server

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

Note

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

3.11.2. hub downgrade

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

3.11.3. hub get

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

3.11.4. hub info

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

3.11.5. hub install

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

3.11.6. hub reinstall

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

3.11.8. hub upgrade

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

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