配置方法
交互式配置
运行 configure 命令,按提示逐项输入:
ctyun-cli configure交互过程:
[INFO] 开始配置天翼云CLI...
Access Key [ecff64d77e2b4c9b869a22c1387dbf4e]:
Secret Key [e8cf************************2b09]:
输出格式 (json/table) [json]:
开启日志 (true/false) [false]:
日志文件路径:
日志格式 (text/json):
[OK] 配置已保存到 C:\Users\Administrator\.ctyun-cli.yaml说明:
1. 已有配置值时, SecretKey 以掩码形式显示(如 dd2b****786d3),其他字段明文显示;
2. 直接按回车可保留当前值。
配置文件
配置文件默认路径:
Linux / macOS:~/.ctyun-cli.yaml
Windows:%USERPROFILE%\.ctyun-cli.yaml
也可通过 --config / -c 指定其他路径:
ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 --config /path/to/config.yaml手动创建或编辑配置文件:
# ~/.ctyun-cli.yaml
access_key: "your-access-key" # 天翼云 AccessKey
secret_key: "your-secret-key" # 天翼云 SecretKey
output: "json" # 输出格式 (json/table)
log: false # 是否开启日志
log_file: "" # 日志文件路径;为空时输出到 stderr
log_format: "text" # 日志格式 (text/json)说明:配置文件中的 AccessKey 保持明文, SecretKey 加密存储,具体加密方式可参考 访问凭证管理-访问凭证配置-配置文件 。
其他方式
除去交互式配置和编辑配置文件外,配置项还支持环境变量或在命令执行时直接指定。
| 配置项 | 配置文件字段 | 环境变量 | 命令行参数 |
|---|---|---|---|
| 天翼云 AccessKey | access_key | CTYUN_AK | --access-key / -a |
| 天翼云 SecretKey(配置文件中加密存储) | secret_key | CTYUN_SK | --secret-key / -s |
| 输出格式(json/table,默认 json) | output | — | --output / -o |
| 是否开启日志;开启后记录命令埋点、请求参数和响应体 | log | CTYUN_LOG | --log |
| 日志文件路径;为空时输出到 stderr | log_file | CTYUN_LOG_FILE | --log-file |
| 日志格式(text/json,默认 text) | log_format | CTYUN_LOG_FORMAT | --log-format |
配置项
输出格式
通过 --output / -o 控制返回结果的展示格式,支持 json(默认)和 table:
# JSON 输出(默认) ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 # Table 输出 ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 -o table
通过 --cli-query 可使用 JMESPath 表达式对返回结果进行过滤。
说明:更加详细的使用说明可参考 输出与过滤
埋点与日志
默认不输出日志。开启 --log 后,CLI会记录命令调用和HTTP请求的结构化日志:
# 输出日志到 stderr
ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 --log
# 写入文件并记录请求/响应
ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 --log --log-file ./ctyun-cli.log安全提示:日志不会记录AccessKey、SecretKey或签名Header。开启日志后会记录业务请求参数和响应体,如果其中包含密码、Token、手机号等敏感信息,建议只在本地或受控环境临时开启。
优先级说明
当用户配置多种方式时,天翼云CLI工具取值优先级从高到低为:命令行参数 > 配置文件 > 环境变量,三种配置方式效果相同。
示例:若配置文件中设置了 access_key: "key-from-file",同时环境变量 CTYUN_AK="key-from-env",则 CLI 使用配置文件中的值;若再通过 --access-key key-from-cli 传入,则使用命令行参数的值。全局参数一览
前文已详述各类配置项的使用方法,下文整理全部全局参数完整清单,此类全局参数可在子命令执行时传入使用。
Flags:
-a, --access-key string 天翼云 AccessKey (环境变量: CTYUN_AK)
-b, --body string 请求体 JSON(手动覆盖,优先级最高)
--cli-query string JMESPath 查询表达式,用于筛选 API 返回结果
-c, --config string 指定配置文件路径 (默认 ~/.ctyun-cli.yaml)
-h, --help help for ctyun-cli
--log 开启日志;开启后记录命令埋点、请求参数和响应体 (环境变量: CTYUN_LOG)
--log-file string 日志文件路径,默认输出到 stderr (环境变量: CTYUN_LOG_FILE)
--log-format string 日志格式 (text|json,环境变量: CTYUN_LOG_FORMAT)
-o, --output string 输出格式 (json|table,默认 json)
-s, --secret-key string 天翼云 SecretKey (环境变量: CTYUN_SK)