Merge pull request #22808 from nkakkar81/enable-tab-completion-tkn

Enable Tab Completion on tkn

Author: bmcelvee

_topic_map.yml

@@ -1388,6 +1388,8 @@ Topics:
   Topics:
   - Name: Installing tkn
     File: installing-tkn
+  - Name: Configuring tkn
+    File: op-configuring-tkn
   - Name: Basic tkn commands
     File: op-tkn-reference
 ---

cli_reference/tkn_cli/op-configuring-tkn.adoc

@@ -0,0 +1,12 @@
+[id="op-configuring-tkn"]
+= Configuring the OpenShift Pipelines `tkn` CLI
+include::modules/common-attributes.adoc[]
+include::modules/pipelines-document-attributes.adoc[]
+:context: configuring-tkn
+
+toc::[]
+
+Configure the {pipelines-title} `tkn` CLI to enable tab completion.
+
+// Enabling tab completion
+include::modules/op-tkn-enabling-tab-completion.adoc[leveloffset=+1]

modules/op-tkn-enabling-tab-completion.adoc

@@ -0,0 +1,33 @@
+// Module included in the following assemblies:
+//
+// * cli_reference/tkn_cli/installing-tkn.adoc
+
+[id="op-tkn-enabling-tab-completion_{context}"]
+= Enabling tab completion
+
+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.
+
+. Save the Bash completion code to a file:
++
+----
+$ tkn completion bash > tkn_bash_completion
+----
+
+. Copy the file to `/etc/bash_completion.d/`:
++
+----
+$ sudo cp tkn_bash_completion /etc/bash_completion.d/
+----
++
+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.