配置自动补全功能

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

配置在Bash中自动补全

Linux

1. 执行如下命令，安装并启用bash-completion。

   yum install -y bash-completion
   source /usr/share/bash-completion/bash_completion
   

2. 执行如下命令，配置volcengine-cli自动补全脚本。

   echo 'source <(volcengine-cli completion bash)' >> ~/.bashrc
   volcengine-cli completion bash > /etc/bash_completion.d/volcengine-cli
   source ~/.bashrc
   

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

   volcengine-cli ecs
   

   正常补全回显示例：
   

MacOS

1. 在终端中执行如下命令，通过brew安装bash-completion。

   brew install bash-completion
   

2. 根据安装成功提示或执行如下命令，获取bash-completion配置告警（Caveats）。

   brew info bash-completion
   

   
3. 执行如下命令，打开~/.bash_profile文件，将步骤2获取的配置内容添加到文件中，保存并关闭文件。

   open ~/.bash_profile 
   

4. 执行如下命令，使配置文件生效。

   source ~/.bash_profile 
   

5. 执行如下命令，将volcengine-cli的bash补全脚本导入bash-completion。

   volcengine-cli completion bash > $(brew --prefix)/etc/bash_completion.d/volcengine-cli
   

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

   volcengine-cli ecs
   

   正常补全回显示例：
   

配置在Zsh中自动补全

1. 若您运行volcengine-cli工具的服务器未启用shell completion，需执行如下命令，启用该功能。

   echo "autoload -U compinit; compinit" >> ~/.zshrc
   

2. 执行如下命令，配置volcengine-cli自动补全脚本。
   • Linux

     volcengine-cli completion zsh > "${fpath[1]}/_volcengine-cli"
     

   • MacOS

     volcengine-cli completion zsh > $(brew --prefix)/etc/site-function/_volcengine-cli
     

3. 重新打开Zsh窗口，使自动补全脚本生效。
4. 输入如下命令，并按Tab键，验证自动补全功能是否正常使用。

   volcengine-cli ecs
   

   正常补全回显示例：
   

配置在Fish中自动补全

1. 执行如下命令，为当前Fish窗口开启volcengine-cli自动补全功能。

   volcengine-cli completion fish | source
   

2. 执行如下命令，为后续新打开的Fish窗口开启volcengine-cli自动补全功能。

   volcengine-cli completion fish > ~/.config/fish/completions/volcengine-cli.fish
   

配置在PowerShell中自动补全

1. 在PowerShell中执行如下命令，在当前窗口中启用volcengine-cli自动补全功能。

   volcengine-cli completion powershell | Out-String | Invoke-Expression
   

2. 为后续新打开的PowerShell窗口，开启volcengine-cli自动补全功能。
   1. 执行如下命令，验证是否已有PowerShell配置文件。

      Test-Path $PROFILE
      

      • 若返回False，请执行如下命令创建配置文件，再执行后续操作。

        if (!(Test-Path -Path $PROFILE)) {
           New-Item -ItemType File -Path $PROFILE -Force
           }
        

      • 若返回True，请继续执行后续操作。
   2. 执行如下命令，生成volcengine-cli自动补全脚本文件。

      volcengine-cli completion powershell > volcengine-cli.ps1
      

   3. 执行如下命令，打开volcengine-cli自动补全脚本并复制全部内容。

      notepad volcengine-cli.ps1
      

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

      notepad $PROFILE
      

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

      volcengine-cli ecs Describe 
      

      正常补全回显示例：