You need to enable JavaScript to run this app.
导航
配置自动补全功能
最近更新时间:2024.01.15 12:12:12首次发布时间:2024.01.11 16:02:46

本文介绍在Bash、Zsh、PowerShell等脚本解释器中,配置火山引擎CLI工具的自动补全功能。配置后,即可通过Tab键快速补全CLI命令、接口名及参数名等内容。

配置在Bash中自动补全

Linux

  1. 执行如下命令,安装并启用bash-completion。
yum install -y bash-completion
source /usr/share/bash-completion/bash_completion
  1. 执行如下命令,配置cli的自动补全脚本。
echo 'source <(ve completion bash)' >> ~/.bashrc
ve completion bash > /etc/bash_completion.d/ve
source ~/.bashrc
  1. 输入如下命令,并按Tab键,验证自动补全功能是否正常使用。
ve ecs

正常补全回显示例:

MacOS

  1. 在终端中执行如下命令,通过brew安装bash-completion。
brew install bash-completion
  1. 根据安装成功提示或执行如下命令,获取bash-completion配置告警(Caveats)。
brew info bash-completion

  1. 执行如下命令,打开~/.bash_profile文件,将步骤2获取的配置内容添加到文件中,保存并关闭文件。
open ~/.bash_profile
  1. 执行如下命令,使配置文件生效。
source ~/.bash_profile
  1. 执行如下命令,将CLI工具的bash补全脚本导入bash-completion。
ve completion bash > $(brew --prefix)/etc/bash_completion.d/ve
  1. 输入如下命令,并按Tab键,验证自动补全功能是否正常使用。
ve ecs

正常补全回显示例:
alt

说明

  • 若出现_get_comp_words_by_ref: command not found的错误,请再次检查bash-completion是否安装配置成功。

  • 您可以执行ve completion bash命令,查看cli的Bash补全脚本内容。

配置在Zsh中自动补全

  1. 若您运行CLI工具的终端未启用shell completion,需执行如下命令,启用该功能。
echo "autoload -U compinit; compinit" >> ~/.zshrc
  1. 执行如下命令,配置CLI工具自动补全脚本。
    a. Linux

    ve completion zsh > "${fpath[1]}/_ve"
    

    b. MacOS

    ve completion zsh > $(brew --prefix)/etc/site-function/_ve
    
  2. 重新打开Zsh窗口,使自动补全脚本生效。

  3. 输入如下命令,并按Tab键,验证自动补全功能是否正常使用。

ve ecs

正常补全回显示例:
alt

配置在Fish中自动补全

  1. 执行如下命令,为当前Fish窗口开启CLI工具的自动补全功能。
ve completion fish | source
  1. 执行如下命令,为后续新打开的Fish窗口开启CLI工具的自动补全功能。
vecompletion fish > ~/.config/fish/completions/ve.fish

配置在PowerShell中自动补全

  1. 在PowerShell中执行如下命令,在当前窗口中启用CLI工具的自动补全功能。
ve completion powershell | Out-String | Invoke-Expression
  1. 为后续新打开的PowerShell窗口,开启CLI工具的自动补全功能。
    a. 执行如下命令,验证是否已有PowerShell配置文件。

    Test-Path $PROFILE
    

    b. 执行如下命令,生成CLI工具的自动补全脚本文件。

    ve completion powershell > ve.ps1
    

    c. 执行如下命令,打开CLI工具的自动补全脚本并复制全部内容。

    notepad ve.ps1
    

    d. 执行如下命令,打开PowerShell配置文件,将上一步复制到补齐脚本内容粘贴到配置文件中,保存并关闭文件。

    notepad $PROFILE
    

    e. 打开新PowerShell窗口,输入如下命令,按Tab键验证自动补全功能是否正常使用。

    ve ecs Describe
    

    f. 正常补全回显示例: