命令行补全

报告问题 查看源代码

您可以在 Bash 和 Zsh 中启用命令行补全功能(也称为 Tab 自动补全)。这样,您便能以 Tab 键填满命令名称、标志名称和标志值以及目标名称。

Bash

Bazel 附带一个 Bash 完成脚本。

如果您安装了 Bazel:

  • 在 APT 代码库中,您便大功告成了:Bash 完成脚本已安装在 /etc/bash_completion.d 中。

  • 完成上述操作后,Bash 完成脚本就已经安装到 $(brew --prefix)/etc/bash_completion.d 中了。

  • 从从 GitHub 下载的安装程序中,然后执行以下操作:

    1. 找到完成文件的绝对路径。安装程序将其复制到 bin 目录。

      示例:如果您使用 --user 运行了安装程序,结果将为 $HOME/.bazel/bin。如果您以 root 身份运行了安装程序,则此路径将为 /usr/local/lib/bazel/bin

    2. 执行以下其中一项操作:

      • 将此文件复制到您的完成目录(如果有)。

        示例:在 Ubuntu 上,该目录为 /etc/bash_completion.d

      • 或者从 Bash 的 RC 文件获取完成文件。

        使用补全文件的绝对路径添加类似于下面这行代码至 ~/.bashrc(在 Ubuntu 上)或 ~/.bash_profile(在 macOS 上)中:

        source /path/to/bazel-complete.bash
        
  • 通过引导功能,然后:

    1. 构建完成脚本:

      bazel build //scripts:bazel-complete.bash
      
    2. 完成文件是在 bazel-bin/scripts/bazel-complete.bash 下构建的。

      执行以下其中一项操作:

      • 将此文件复制到您的完成目录(如果有)。

        示例:在 Ubuntu 上,该目录为 /etc/bash_completion.d

      • 将其复制到本地磁盘上的某个位置(例如 $HOME),然后从 Bash 的 RC 文件中获取完成文件。

        使用补全文件的绝对路径添加类似于下面这行代码至 ~/.bashrc(在 Ubuntu 上)或 ~/.bash_profile(在 macOS 上)中:

        source /path/to/bazel-complete.bash
        

Zsh

Bazel 附带 Zsh 完成脚本。

如果您安装了 Bazel:

  • 从 APT 代码库中,您便完成了 -- Zsh 完成脚本已安装在 /usr/share/zsh/vendor-completions 中。

    如果您的 .zshrc 经过大量自定义,而自动补全功能无法正常运行,请尝试以下解决方案之一:

    将以下内容添加到 .zshrc 中:

        zstyle :compinstall filename '/home/tradical/.zshrc'
    
        autoload -Uz compinit
        compinit
    

    请按照此处的说明进行操作

    如果您使用的是 oh-my-zsh,则可能需要安装并启用 zsh-autocomplete 插件。如果您不愿意,请使用上述解决方案之一。

  • 从 Homerew 开始,就大功告成了:Zsh 完成脚本已安装在 $(brew --prefix)/share/zsh/site-functions 中。

  • 从从 GitHub 下载的安装程序中,然后执行以下操作:

    1. 找到完成文件的绝对路径。安装程序将其复制到 bin 目录。

      示例:如果您使用 --user 运行了安装程序,结果将为 $HOME/.bazel/bin。如果您以 root 身份运行了安装程序,则此路径将为 /usr/local/lib/bazel/bin

    2. 将此脚本添加到 $fpath 上的目录中:

      fpath[1,0]=~/.zsh/completion/
      mkdir -p ~/.zsh/completion/
      cp /path/from/above/step/_bazel ~/.zsh/completion
      

      您可能需要首次调用 rm -f ~/.zcompdump; compinit 才能使其正常运行。

    3. (可选)将以下内容添加到 .zshrc 中。

      # This way the completion script does not have to parse Bazel's options
      # repeatedly.  The directory in cache-path must be created manually.
      zstyle ':completion:*' use-cache on
      zstyle ':completion:*' cache-path ~/.zsh/cache