配置 volcengine-cli

本文介绍了使用 volcengine-cli 过程中可配置的内容，其中凭证配置为必需配置。

配置环境变量

1. （可选）确认 $PATH 系统变量是否存在 /usr/local/bin，若没有则需根据实际情况为 volcengine-cli 设置可用的环境变量。

2. （可选）执行下面的命令，将 volcengine-cli 复制到 /usr/local/bin 目录下。

   sudo cp volcengine-cli /usr/local/bin
   

   说明

   如不复制，在使用 volcengine-cli 时需要执行 ./volcengine-cli 命令；如完成了复制，在使用 volcengine-cli 时需要执行 volcengine-cli。

配置凭证

在调用服务接口过程中需要使用 AccessKey、SecretKey 和地域（region）信息，因此需要在 volcengine-cli 中进行配置。可通过新建配置和环境变量两种方式进行配置。

新建配置

新建配置需要执行以下 configure 命令：

volcengine-cli configure set --profile [配置名] --region [地区] --access-key [用户的 AK] --secret-key [用户的 SK] --endpoint [地区对应的 endpoint]

该命令中各参数的说明如下：

可使用以下命令获得更多参数信息。

volcengine-cli configure set -h

环境变量

如果配置文件中没有 AccessKey、SecretKey 和地域（region）的配置信息，volcengine-cli 会自动尝试从环境变量中读取信息。

export VOLCENGINE_ACCESS_KEY=AccessKey
export VOLCENGINE_SECRET_KEY=SecretKey
export VOLCENGINE_REGION=RegionName

# 是否禁用SSL, 不设置的话默认为 false
export VOLCENGINE_SESSION_TOKEN=false

# 如果使用角色扮演，需要提供
export VOLCENGINE_SESSION_TOKEN=sessionToken

Configure 命令的其他操作

• 获取指定配置信息
  获取指定配置通过以下命令实现。 其中 profile 为可选字段，若不指定 profile 字段则会展示当前配置；若指定了 profile 则 volcengine-cli 会尝试获取指定配置并展示。若通过 profile 指定的配置不存在，则返回的配置字段全为默认值。

  volcengine-cli configure get --profile [配置名]
  

• 显示当前所有配置信息

  volcengine-cli configure list
  

• 修改配置 修改配置通过以下命令实现。profile 字段为必选字段。

  volcengine-cli configure set --profile [配置名] --region [地区] --access-key [用户的AK] --secret-key [用户的SK] --endpoint [地区对应的endpoint]
  

  其余可指定的字段：

  • access-key
  • secret-key
  • region
  • session-token
  • disable-ssl

• 删除配置
  删除配置通过以下命令实现。删除配置时必须指定 profile 字段以指定需要删除的配置。若待删除的是当前正在使用的配置，删除成功后 volcengine-cli 会尝试从剩余的配置中随机挑选一个作为当前配置。

  volcengine-cli configure delete --profile [配置名]
  

配置自动补全

使用 volcengine-cli completion --help 命令可以查看各种终端下配置自动补全的方式，您可以根据提示信息选择是否配置自动补全功能。

在 Bash 配置自动补全

volcengine-cli 的 Bash 补全脚本可以通过 volcengine-cli completion bash 进行查看，在 Shell 中导入该自动补全脚本，即可开启自动补全功能。

1. 安装 bash-completion。 volcengine-cli 补全脚本依赖工具 bash-completiom，因此需要先安装并启用 bash-completion。可以用命令 type _init_completion 检查 bash-completion 是否已安装。

   1. 使用以下命令安装 bash-completion：

      yum install bash-completion
      

      或

      apt-get install bash-completion
      

   2. 使用以下命令启用 bash-completion：

      source /usr/share/bash-completion/bash_completion
      

   说明

   建议将 source /usr/share/bash-completion/bash_completion 添加至 ~/.bashrc 中.

   8. 使用 type _init_completion 命令检查 bash-completion 是否安装成功。

2. 配置自动补全。 按以下步骤配置即可在 Bash 下开启自动补全功能：

   1. 在 Bash 中启用 bash-completion。

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

   3. 配置自动补全。

   volcengine-cli completion bash > /etc/bash_completion.d/volcengine-cli
   

   5. 重新加载 Shell ，或者执行 source ~/.bashrc 命令后即可生效。

      说明

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

在 Zsh 配置自动补全

volcengine-cli 的 Zsh 补全脚本可以通过 volcengine-cli completion zsh 进行查看，在 Shell 中导入该自动补全脚本，即可开启自动补全功能。
按以下步骤配置即可在 Zsh 下开启自动补全功能：

1. 在 Zsh 中启用 compinit。

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

2. 配置自动补全。

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

3. 重新加载 Shell，或者执行 source ~/.zshrc 命令后即可生效。

配置颜色

使用 volcengine-cli enable-color 可以开启彩色显示功能。
使用 volcengine-cli disable-color 可以关闭彩色显示功能。