更新时间:2024-04-18 GMT+08:00
分享

交互式提示

KooCLI支持功能强大的多平台支持的交互式提示,方便命令构建,在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容,提示云服务名称,API的operation,参数及其描述信息,也提供部分参数值的补全功能。

  • 交互式的使用方式如下:
    • 交互模式中使用“Tab”或向上箭头、向下箭头键实现待补全内容的上下选择。
    • 选中待补全内容后,使用空格键将已选内容追加到当前命令中。
    • 进入交互模式后,使用“Ctrl+C”可切换至新命令行,使用“Ctrl+D”可退出交互模式。
  • 交互式可提示和补全如下内容:
    • 云服务

      初次进入交互模式后,会自动提示云服务及系统命令列表。

      图1 交互式中提示云服务和系统命令列表

      所提示的云服务列表中,左列展示云服务短名/系统命令,右列展示该云服务的服务名称/该系统命令的描述信息。

    • API

      已输入的云服务/系统命令经校验无误后,会继续提示该服务的API列表/该系统命令的子命令(或参数)。

      所提示的系统命令列表中,左列展示该系统命令的子命令(或参数),右列展示该子命令(或参数)的描述信息。

      图2 交互式中提示云服务的API列表

      所提示的云服务API列表中,左列展示API的operation名称,右列展示该API的描述信息。

      图3 交互式中提示系统命令的子命令
      图4 交互式中提示系统命令的参数

      若已输入的云服务/系统命令非法,则不再提示任何信息。

    • 参数

      已输入服务名与API的operation,或已输入系统命令及其子命令经校验无误后,会继续提示该API/系统命令子命令的参数列表。

      图5 交互式中提示云服务API的参数列表
      图6 交互式中提示系统命令子命令的参数列表

      所提示的参数列表中,左列展示参数名称;右列展示该参数的描述信息。

      若已输入API的operation/系统命令子命令非法,或已输入的参数名非法,则不再提示任何信息。

    • 参数值

      在交互式中,在部分参数名后输入等号,会提示该参数的可取值或默认值列表。例如:若调用API的命令中当前输入的参数是“--cli-region=”时,会提示该API的可选区域列表。

      图7 交互式中提示已输入云服务API的可选区域列表
  • 交互模式下的快捷键
    • Ctrl + W:将光标前的单词删除
    • Ctrl + K:将光标之后的内容删除
    • Ctrl + U:将光标之前的内容删除
    • Ctrl + L:清除屏幕
  • 若用户尚未添加配置项,或默认配置项中的区域不被命令中的API所支持,用户需先根据提示,从目标API支持的cli-region列表中选择合适的区域值。确定区域后,KooCLI会继续提示该API的参数列表。
  • 交互式提示参数时,除自定义map类型的参数(即:参数名中包含“{*}”的参数)外,已输入的参数不会重复提示;若提示的参数名中有“[N]”,其含义为索引位,请使用数字代替该字符;若提示的参数名中有“{*}”,其含义为自定义参数名称,请使用任意不含“.”的字符串代替该字符。
  • 切换至新命令行后可使用向上箭头和向下箭头浏览已执行命令的历史记录。

相关文档