ZSH(5.8)/WSL2下SSH主机名补全功能仅部分生效问题

问题现象 #

• 主~/.ssh/config文件通过Include指令引入了额外配置文件，SSH连接功能正常
• Zsh的SSH主机名补全仅对主配置文件内的主机生效（如输入my_按Tab可补全my_host1）
• 被Include的配置文件中的主机名无法触发补全（如输入a_按Tab无响应）
• 直接输入完整主机名（如a_host1）可正常建立SSH连接
• 将所有配置合并到单个文件后，补全功能对所有主机生效

配置示例 #

主配置文件 ~/.ssh/config #

Include ~/.ssh/config_a # hosts of a
Include ~/.ssh/config_b # hosts of b

# myhost
Host my_host1
...(skip)

被Include的配置文件 ~/.ssh/config_a #

# in a
Host a_host1
...(skip)

测试命令 #

ssh my_ # 按Tab补全生效
ssh a_ # 按Tab补全失效

ssh a_host1 # SSH连接正常

解决方案 #

方法一：通过ssh -G获取所有主机名（推荐） #

Zsh默认的SSH补全脚本未处理Include指令，但ssh -G会解析完整的SSH配置（包括所有Include的文件）。在~/.zshrc中添加以下代码：

_ssh_hosts() {
  local hosts=()
  # 通过ssh -G提取所有配置的主机名
  hosts=($(ssh -G dummy | awk '/^Host / {for(i=2;i<=NF;i++) print $i}'))
  _wanted hosts expl 'remote host' compadd -a hosts
}

compdef _ssh_hosts ssh

添加后执行source ~/.zshrc重新加载配置，此时输入ssh a_按Tab即可触发补全。

方法二：修改Zsh的SSH补全脚本，支持Include指令 #

找到Zsh的SSH补全文件（通常路径为/usr/share/zsh/functions/Completion/Unix/_ssh），修改其中读取配置的逻辑，添加递归解析Include的功能：

1. 在脚本开头添加递归读取配置的函数：

_ssh_read_config() {
  local config_file=$1
  while IFS= read -r line; do
    # 去掉行内注释和开头空格
    line=${line%%\#*}
    line=${line## }
    # 处理Include指令
    if [[ $line == Include* ]]; then
      local include_files=${line#Include }
      for file in $include_files; do
        # 替换路径中的~为用户主目录
        file=${file/#\~/$HOME}
        if [[ -f $file ]]; then
          _ssh_read_config "$file"
        fi
      done
    # 提取Host字段
    elif [[ $line == Host* ]]; then
      local host=${line#Host }
      hosts+=($host)
    fi
  done < "$config_file"
}

2. 找到原来读取主配置文件的代码段，替换为调用上述函数：

# 替换原有的读取逻辑
local hosts=()
_ssh_read_config "$HOME/.ssh/config"

保存修改后，重启Zsh或执行source /usr/share/zsh/functions/Completion/Unix/_ssh即可生效。

方法三：手动合并配置文件（临时方案） #

在~/.zshrc中添加自动合并配置的命令，生成一个包含所有主机的合并文件：

# 合并所有SSH配置到临时文件
cat ~/.ssh/config ~/.ssh/config_a ~/.ssh/config_b > ~/.ssh/config_merged

然后修改Zsh补全脚本中的配置文件路径为~/.ssh/config_merged，但此方案需要维护合并逻辑，不如前两种方法灵活。

内容的提问来源于stack exchange，提问作者fver1004