modules/cli-configuring-completion.adoc

// Module included in the following assemblies:
//
// * cli_reference/openshift_cli/configuring-cli.adoc

:_mod-docs-content-type: PROCEDURE
[id="cli-enabling-tab-completion_{context}"]
= Enabling tab completion for Bash

After you install the OpenShift CLI (`oc`), you can enable tab completion to automatically complete `oc` commands or suggest options when you press Tab. The following procedure enables tab completion for the Bash shell.

.Prerequisites

* You must have the OpenShift CLI (`oc`) installed.
* You must have the package `bash-completion` installed.

.Procedure

. Save the Bash completion code to a file:
+
[source,terminal]
----
$ oc completion bash > oc_bash_completion
----

. Copy the file to `/etc/bash_completion.d/`:
+
[source,terminal]
----
$ sudo cp oc_bash_completion /etc/bash_completion.d/
----
+
You can also 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.
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00			`// Module included in the following assemblies:`
			`//`
Renaming CLI reference bucket to CLI tools 2019-10-02 11:30:49 -04:00			`// * cli_reference/openshift_cli/configuring-cli.adoc`
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00
[enterprise-4.14] changing content type attribute 2023-10-30 10:13:25 -04:00			`:_mod-docs-content-type: PROCEDURE`
changed -{context} to _{context} 2019-05-13 08:55:00 +10:00			`[id="cli-enabling-tab-completion_{context}"]`
Expanded the oc completion page to include the setup steps for both Bash, and Zsh shell's fixed an error in the zsh completion steps, the command now includes the absolute path to .zshrc file 2022-07-13 14:18:06 +03:00			`= Enabling tab completion for Bash`
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00
Expanded the oc completion page to include the setup steps for both Bash, and Zsh shell's fixed an error in the zsh completion steps, the command now includes the absolute path to .zshrc file 2022-07-13 14:18:06 +03:00			After you install the OpenShift CLI (`oc`), you can enable tab completion to automatically complete `oc` commands or suggest options when you press Tab. The following procedure enables tab completion for the Bash shell.
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00
			`.Prerequisites`

Expanded the oc completion page to include the setup steps for both Bash, and Zsh shell's fixed an error in the zsh completion steps, the command now includes the absolute path to .zshrc file 2022-07-13 14:18:06 +03:00			* You must have the OpenShift CLI (`oc`) installed.
BZ1812974: Added additional prerequisite step 2021-06-22 15:29:52 -04:00			* You must have the package `bash-completion` installed.
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00
			`.Procedure`

Expanded the oc completion page to include the setup steps for both Bash, and Zsh shell's fixed an error in the zsh completion steps, the command now includes the absolute path to .zshrc file 2022-07-13 14:18:06 +03:00			`. Save the Bash completion code to a file:`
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00			`+`
Separating command and output for oc CLI docs 2020-08-04 22:42:35 -04:00			`[source,terminal]`
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00			`----`
			`$ oc completion bash > oc_bash_completion`
			`----`

Expanded the oc completion page to include the setup steps for both Bash, and Zsh shell's fixed an error in the zsh completion steps, the command now includes the absolute path to .zshrc file 2022-07-13 14:18:06 +03:00			. Copy the file to `/etc/bash_completion.d/`:
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00			`+`
Separating command and output for oc CLI docs 2020-08-04 22:42:35 -04:00			`[source,terminal]`
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00			`----`
			`$ sudo cp oc_bash_completion /etc/bash_completion.d/`
			`----`
			`+`
Expanded the oc completion page to include the setup steps for both Bash, and Zsh shell's fixed an error in the zsh completion steps, the command now includes the absolute path to .zshrc file 2022-07-13 14:18:06 +03:00			You can also save the file to a local directory and source it from your `.bashrc` file instead.
OSDOCS-241: Adding installing CLI plugins 2019-02-22 08:49:56 -05:00
			`Tab completion is enabled when you open a new terminal.`