基础命令
基础命令包含configure、version、completion、help四类，主要完成认证配置、版本查看、Shell补全生成和帮助查看等准备工作。
configure — 交互式配置
首次使用前，通过交互式命令完成认证配置：
ctyun-cli configure按提示输入AccessKey、SecretKey等信息，配置保存到 ~/.ctyun-cli.yaml。
version — 查看版本
ctyun-cli version输出当前CLI的版本号。
completion — 生成 Shell 自动补全脚本
启用自动补全后，在终端输入命令时按 Tab 键即可自动补全产品名、Action名和参数名，无需记忆完整拼写。例如输入 `ctyun-cli vpc L` 后按 Tab，可自动补全为 `ctyun-cli vpc ListVpc`。
ctyun-cli completion <shell>支持的shell：bash、zsh、fish、powershell。
各shell的启用方式：
| Shell | 持久化 | 当前会话 |
|---|---|---|
| Bash | ctyun-cli completion bash > /etc/bash_completion.d/ctyun-cli | source <(ctyun-cli completion bash) |
| Zsh | ctyun-cli completion zsh > "${fpath[1]}/_ctyun-cli" | source <(ctyun-cli completion zsh) |
| Fish | ctyun-cli completion fish > ~/.config/fish/completions/ctyun-cli.fish | — |
| PowerShell | ctyun-cli completion powershell >> $PROFILE | ctyun-cli completion powershell \| Out-String \| Invoke-Expression |
help — 查看帮助
# 列出所有产品
ctyun-cli --help
# 列出该产品所有操作
ctyun-cli vpc --help
# 列出该操作所有参数
ctyun-cli vpc ListVpc --help 说明：帮助信息包含所有可用参数【必填参数标注 (必填)】、复杂类型参数的子字段结构及响应示例。
业务命令
业务命令指以固定格式调用天翼云各产品OpenAPI，支持 flag 传参、--body JSON 传参和复杂类型参数，帮助信息中可查看字段名、字段类型、是否必填等信息。业务命令采用标准化统一格式调用天翼云各产品OpenAPI，提供多种参数传入方式：支持通过独立 flag 逐项传入参数、借助 --body 参数提交完整 JSON 请求体，同时兼容多层级复杂结构体参数。每条命令配套完整帮助文档，可直接查询接口参数字段名称、数据类型、必填标识等接口规范信息。
基本格式
ctyun-cli <product> <action> [flags]| 部分 | 说明 | 示例 |
|---|---|---|
| ctyun-cli | CLI 可执行文件名 | — |
| <product> | 产品标识 | vpc、ecs、evs |
| <action> | 操作名称 | ListVpc、CreateVpc |
| [flags] | 操作参数和全局参数 | --regionID xxx、-o table |
注意：产品名、Action名和参数名区分大小写，必须与 --help 输出中的名称完全一致。
操作参数
每个操作的参数通过 --help 查看，使用 --参数名 值 的方式传入：
ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 --pageNumber 1 --pageSize 10
ctyun-cli vpc CreateVpc --clientToken "3dbb3c17-cbdc-465d-9e7b-64c936a211d3" --name "my-vpc" --CIDR "172.31.0.0/16" --regionID bb9fdb42056f11eda1610242ac110002–body 参数
所有业务操作都支持 --body / -b 参数，直接传入 JSON 请求体。--body 中的字段优先级最高，会覆盖同名参数的值。
ctyun-cli vpc CreateVpc --body '{"clientToken":"3dbb3c17-cbdc-465d-9e7b-64c936a211d3","name":"my-vpc","CIDR":"172.31.0.0/16","regionID":"bb9fdb42056f11eda1610242ac110002"}'适用场景：
参数较多时，直接传入 JSON 更方便
需要覆盖某个参数的值时
说明：使用 --body 前先通过 --help 查看该操作的必填参数，确保 JSON 中包含所有必填字段。
复杂类型参数
Object、Array等复杂类型参数需要传入JSON字符串。复杂类型参数的子字段结构会在 --help 的 Complex Parameter 部分展示，包含每个子字段的名称、类型、是否必填和说明。
# Object 类型 — 传入 JSON 对象
ctyun-cli <product> <action> --<objectParam> '{"key1":"value1","key2":"value2"}'
# Array 类型 — 传入 JSON 数组
ctyun-cli <product> <action> --<arrayParam> '["value1","value2"]'注意：通过PowerShell使用时，JSON字符串中的引号需要正确转义。
必填参数
必填参数在 --help 中标注为 (必填)。如果必填参数未通过 flag 或 --body 提供，CLI 会报错提示缺失的参数名。
# 缺少必填参数时的报错示例
错误: 必填参数未提供: regionID（可通过 flag 或 --body 传参）查看帮助信息
CLI 支持的产品和操作在安装时已内置，可通过 --help 逐级浏览：
# 查看所有产品
ctyun-cli --help
# 查看某产品下的所有操作
ctyun-cli vpc --help
# 查看某操作的所有参数
ctyun-cli vpc ListVpc --help说明：帮助信息包含所有可用参数（必填参数标注 (必填)）、复杂类型参数的子字段结构及响应示例。
