website/content/zh-cn/docs/tasks/tools/included/optional-kubectl-configs-bash-mac.md

title	description	headless	_build
macOS 系统上的 bash 自动补全	在 macOS 上实现 Bash 自动补全的一些可选配置。	true	list render publishResources never never false

简介

kubectl 的 Bash 补全脚本可以通过 kubectl completion bash 命令生成。 在你的 Shell 中导入（Sourcing）这个脚本即可启用补全功能。

此外，kubectl 补全脚本依赖于工具 bash-completion， 所以你必须先安装它。

{{< warning>}}

bash-completion 有两个版本：v1 和 v2。v1 对应 Bash 3.2（也是 macOS 的默认安装版本）， v2 对应 Bash 4.1+。kubectl 的补全脚本无法适配 bash-completion v1 和 Bash 3.2。 必须为它配备 bash-completion v2 和 Bash 4.1+。 有鉴于此，为了在 macOS 上使用 kubectl 补全功能，你必须要安装和使用 Bash 4.1+ （说明）。 后续说明假定你用的是 Bash 4.1+（也就是 Bash 4.1 或更新的版本）。 {{< /warning >}}

升级 Bash

后续说明假定你已使用 Bash 4.1+。你可以运行以下命令检查 Bash 版本：

echo $BASH_VERSION

如果版本太旧，可以用 Homebrew 安装/升级：

brew install bash

重新加载 Shell，并验证所需的版本已经生效：

echo $BASH_VERSION $SHELL

Homebrew 通常把它安装为 /usr/local/bin/bash。

安装 bash-completion

{{< note >}}

如前所述，本说明假定你使用的 Bash 版本为 4.1+，这意味着你要安装 bash-completion v2 （不同于 Bash 3.2 和 bash-completion v1，kubectl 的补全功能在该场景下无法工作）。 {{< /note >}}

你可以用命令 type _init_completion 测试 bash-completion v2 是否已经安装。 如未安装，用 Homebrew 来安装它：

brew install bash-completion@2

如命令的输出信息所显示的，将如下内容添加到文件 ~/.bash_profile 中：

brew_etc="$(brew --prefix)/etc" && [[ -r "${brew_etc}/profile.d/bash_completion.sh" ]] && . "${brew_etc}/profile.d/bash_completion.sh"

重新加载 Shell，并用命令 type _init_completion 验证 bash-completion v2 已经恰当的安装。

启用 kubectl 自动补全功能

你现在需要确保在所有的 Shell 环境中均已导入（sourced）kubectl 的补全脚本， 有若干种方法可以实现这一点：

• 在文件 ~/.bash_profile 中导入（Source）补全脚本：

  echo 'source <(kubectl completion bash)' >>~/.bash_profile
  

• 将补全脚本添加到目录 /usr/local/etc/bash_completion.d 中：

  kubectl completion bash >/usr/local/etc/bash_completion.d/kubectl
  

• 如果你为 kubectl 定义了别名，则可以扩展 Shell 补全来兼容该别名：

  echo 'alias k=kubectl' >>~/.bash_profile
  echo 'complete -o default -F __start_kubectl k' >>~/.bash_profile
  

• 如果你是用 Homebrew 安装的 kubectl （如此页面所描述）， 则 kubectl 补全脚本应该已经安装到目录 /usr/local/etc/bash_completion.d/kubectl 中了。这种情况下，你什么都不需要做。

  {{< note >}}

  用 Hommbrew 安装的 bash-completion v2 会初始化目录 BASH_COMPLETION_COMPAT_DIR 中的所有文件，这就是后两种方法能正常工作的原因。 {{< /note >}}

总之，重新加载 Shell 之后，kubectl 补全功能将立即生效。