@aiot-toolkit/commander NPM

`commander`

仅需配置即可生成命令行工具，支持

默认命令
命令参数
询问式参数
常驻式操作

询问式参数与命令参数的关系

询问式参数是普通参数的子集，询问式参数一定可以直接在命令中输入，以确保工具可自动化运行

某参数在命令中填写后，不会在询问中出现

快速开始

创建配置内容

// bin.ts

import { Command, IProgram } from '@aiot-toolkit/commander'

const config: IProgram = {
  name: 'myTool',
  description: 'myTool is ...',
  version: '1.0.1',
  // 命令列表
  commandList: [
    {
      // 命令名称
      name: 'start',
      // 命令描述
      description: 'start command is ...',
      // 参数列表
      paramList: [
        {
          // 参数名称
          name: 'path',
          // 参数描述
          description: 'path is ...',
          // 是否可询问（true 表示未输入时，则询问）
          enableInquirer: true
        },
        {
          name: 'path2',
          description: 'path2 is ...',
          enableInquirer: true
        }
      ],
      // 命令对应的方法
      action: (option: any) => {
        console.log(option)
      },
      // 常驻式操作
      waiter: new PersistentCommand({
        description: 'start 的常驻式操作',
        options: [
          {
            // 按键
            key: 'a',
            description: 'a 的描述',
            // 按下 a 执行的方法
            action: () => {}
          }
        ]
      })
    }
  ]
}

Command.registeProgram(config)

执行命令

执行 ts-node bin.ts start --path /Documents/temp

此时，会询问 path2 的值；输入后，进入 action，输出 option

命令执行完成后，会显示常驻操作菜单

配置

IProgram

属性	描述	类型	必填
name	工具名称	string	true
description	工具描述	string	true
version	版本号	string	true
defaultCommand	默认命令，无命令名称时，执行此命令	ICommand	false
commandList	命令列表	ICommand[]	false

ICommand

属性	描述	类型	必填
name	命令名称	string	true
description	命令描述	string	true
argumentList	无名称参数, `tool arg1 arg2`	string[]	false
paramList	有名称参数	ParamType	false
action	命令的执行函数，`action:(arg1, arg2, options)=>{}`	true