|
| 1 | +--- |
| 2 | +title: "macOS 系统上的 bash 自动补全" |
| 3 | +description: "在 macOS 上实现 Bash 自动补全的一些可选配置。" |
| 4 | +headless: true |
| 5 | +--- |
| 6 | +<!-- |
| 7 | +--- |
| 8 | +title: "bash auto-completion on macOS" |
| 9 | +description: "Some optional configuration for bash auto-completion on macOS." |
| 10 | +headless: true |
| 11 | +--- |
| 12 | + --> |
| 13 | + |
| 14 | +<!-- |
| 15 | +### Introduction |
| 16 | +--> |
| 17 | +### 简介 |
| 18 | + |
| 19 | +<!-- |
| 20 | +The kubectl completion script for Bash can be generated with `kubectl completion bash`. Sourcing this script in your shell enables kubectl completion. |
| 21 | +
|
| 22 | +However, the kubectl completion script depends on [**bash-completion**](https://github.com/scop/bash-completion) which you thus have to previously install. |
| 23 | +--> |
| 24 | +kubectl 的 Bash 补全脚本可以通过 `kubectl completion bash` 命令生成。 |
| 25 | +在你的 shell 中导入（Sourcing）这个脚本即可启用补全功能。 |
| 26 | + |
| 27 | +此外，kubectl 补全脚本依赖于工具 [**bash-completion**](https://github.com/scop/bash-completion)， |
| 28 | +所以你必须先安装它。 |
| 29 | + |
| 30 | +{{< warning>}} |
| 31 | +<!-- |
| 32 | +There are two versions of bash-completion, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. The kubectl completion script **doesn't work** correctly with bash-completion v1 and Bash 3.2. It requires **bash-completion v2** and **Bash 4.1+**. Thus, to be able to correctly use kubectl completion on macOS, you have to install and use Bash 4.1+ ([*instructions*](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba)). The following instructions assume that you use Bash 4.1+ (that is, any Bash version of 4.1 or newer). |
| 33 | +--> |
| 34 | +bash-completion 有两个版本：v1 和 v2。v1 对应 Bash3.2（也是 macOS 的默认安装版本），v2 对应 Bash 4.1+。 |
| 35 | +kubectl 的补全脚本**无法适配** bash-completion v1 和 Bash 3.2。 |
| 36 | +必须为它配备 **bash-completion v2** 和 **Bash 4.1+**。 |
| 37 | +有鉴于此，为了在 macOS 上使用 kubectl 补全功能，你必须要安装和使用 Bash 4.1+ |
| 38 | +([*说明*](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba))。 |
| 39 | +后续说明假定你用的是 Bash 4.1+（也就是 Bash 4.1 或更新的版本） |
| 40 | +{{< /warning >}} |
| 41 | + |
| 42 | +<!-- |
| 43 | +### Upgrade Bash |
| 44 | +--> |
| 45 | +### 升级 Bash |
| 46 | + |
| 47 | +<!-- |
| 48 | +The instructions here assume you use Bash 4.1+. You can check your Bash's version by running: |
| 49 | +--> |
| 50 | +后续说明假定你已使用 Bash 4.1+。你可以运行以下命令检查 Bash 版本： |
| 51 | + |
| 52 | +```bash |
| 53 | +echo $BASH_VERSION |
| 54 | +``` |
| 55 | + |
| 56 | +<!-- |
| 57 | +If it is too old, you can install/upgrade it using Homebrew: |
| 58 | +--> |
| 59 | +如果版本太旧，可以用 Homebrew 安装/升级： |
| 60 | + |
| 61 | +```bash |
| 62 | +brew install bash |
| 63 | +``` |
| 64 | + |
| 65 | +<!-- |
| 66 | +Reload your shell and verify that the desired version is being used: |
| 67 | +--> |
| 68 | +重新加载 shell，并验证所需的版本已经生效： |
| 69 | + |
| 70 | +```bash |
| 71 | +echo $BASH_VERSION $SHELL |
| 72 | +``` |
| 73 | + |
| 74 | +<!-- |
| 75 | +Homebrew usually installs it at `/usr/local/bin/bash`. |
| 76 | +--> |
| 77 | +Homebrew 通常把它安装为 `/usr/local/bin/bash`。 |
| 78 | + |
| 79 | +<!-- |
| 80 | +### Install bash-completion |
| 81 | +--> |
| 82 | +### 安装 bash-completion |
| 83 | + |
| 84 | + |
| 85 | +{{< note >}} |
| 86 | +<!-- |
| 87 | +As mentioned, these instructions assume you use Bash 4.1+, which means you will install bash-completion v2 (in contrast to Bash 3.2 and bash-completion v1, in which case kubectl completion won't work). |
| 88 | +--> |
| 89 | +如前所述，本说明假定你使用的 Bash 版本为 4.1+，这意味着你要安装 bash-completion v2 |
| 90 | +（不同于 Bash 3.2 和 bash-completion v1，kubectl 的补全功能在该场景下无法工作）。 |
| 91 | +{{< /note >}} |
| 92 | + |
| 93 | +<!-- |
| 94 | +You can test if you have bash-completion v2 already installed with `type _init_completion`. If not, you can install it with Homebrew: |
| 95 | +--> |
| 96 | +你可以用命令 `type _init_completion` 测试 bash-completion v2 是否已经安装。 |
| 97 | +如未安装，用 Homebrew 来安装它： |
| 98 | + |
| 99 | +```bash |
| 100 | +brew install bash-completion@2 |
| 101 | +``` |
| 102 | + |
| 103 | +<!-- |
| 104 | +As stated in the output of this command, add the following to your `~/.bash_profile` file: |
| 105 | +--> |
| 106 | +如命令的输出信息所显示的，将如下内容添加到文件 `~/.bash_profile` 中： |
| 107 | + |
| 108 | +```bash |
| 109 | +export BASH_COMPLETION_COMPAT_DIR="/usr/local/etc/bash_completion.d" |
| 110 | +[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh" |
| 111 | +``` |
| 112 | + |
| 113 | +<!-- |
| 114 | +Reload your shell and verify that bash-completion v2 is correctly installed with `type _init_completion`. |
| 115 | +--> |
| 116 | +重新加载 shell，并用命令 `type _init_completion` 验证 bash-completion v2 已经恰当的安装。 |
| 117 | + |
| 118 | +<!-- |
| 119 | +### Enable kubectl autocompletion |
| 120 | +--> |
| 121 | +### 启用 kubectl 自动补全功能 |
| 122 | + |
| 123 | +<!-- |
| 124 | +You now have to ensure that the kubectl completion script gets sourced in all your shell sessions. There are multiple ways to achieve this: |
| 125 | +
|
| 126 | +- Source the completion script in your `~/.bash_profile` file: |
| 127 | +--> |
| 128 | +你现在需要确保在所有的 shell 环境中均已导入（sourced） kubectl 的补全脚本， |
| 129 | +有若干种方法可以实现这一点： |
| 130 | + |
| 131 | +- 在文件 `~/.bash_profile` 中导入（Source）补全脚本： |
| 132 | + |
| 133 | + ```bash |
| 134 | + echo 'source <(kubectl completion bash)' >>~/.bash_profile |
| 135 | + ``` |
| 136 | + |
| 137 | +<!-- |
| 138 | +- Add the completion script to the `/usr/local/etc/bash_completion.d` directory: |
| 139 | +--> |
| 140 | +- 将补全脚本添加到目录 `/usr/local/etc/bash_completion.d` 中： |
| 141 | + |
| 142 | + ```bash |
| 143 | + kubectl completion bash >/usr/local/etc/bash_completion.d/kubectl |
| 144 | + ``` |
| 145 | + |
| 146 | +<!-- |
| 147 | +- If you have an alias for kubectl, you can extend shell completion to work with that alias: |
| 148 | +--> |
| 149 | +- 如果你为 kubectl 定义了别名，则可以扩展 shell 补全来兼容该别名： |
| 150 | + |
| 151 | + ```bash |
| 152 | + echo 'alias k=kubectl' >>~/.bash_profile |
| 153 | + echo 'complete -F __start_kubectl k' >>~/.bash_profile |
| 154 | + ``` |
| 155 | + |
| 156 | +<!-- |
| 157 | +- If you installed kubectl with Homebrew (as explained [above](#install-with-homebrew-on-macos)), then the kubectl completion script should already be in `/usr/local/etc/bash_completion.d/kubectl`. In that case, you don't need to do anything. |
| 158 | +--> |
| 159 | +- 如果你是用 Homebrew 安装的 kubectl（[如上所述](#install-with-homebrew-on-macos)）， |
| 160 | + 那么 kubectl 补全脚本应该已经安装到目录 `/usr/local/etc/bash_completion.d/kubectl` 中了。 |
| 161 | + 这种情况下，你什么都不需要做。 |
| 162 | + |
| 163 | + {{< note >}} |
| 164 | + <!-- |
| 165 | + The Homebrew installation of bash-completion v2 sources all the files in the `BASH_COMPLETION_COMPAT_DIR` directory, that's why the latter two methods work. |
| 166 | + --> |
| 167 | + 用 Hommbrew 安装的 bash-completion v2 会初始化 目录 `BASH_COMPLETION_COMPAT_DIR` 中的所有文件，这就是后两种方法能正常工作的原因。 |
| 168 | + {{< /note >}} |
| 169 | +
|
| 170 | +<!-- |
| 171 | +In any case, after reloading your shell, kubectl completion should be working. |
| 172 | +--> |
| 173 | +总之，重新加载 shell 之后，kubectl 补全功能将立即生效。 |
0 commit comments