安装

npm i commander

基本使用示例

主要展示了

• 配置名称
• 配置提示信息
• 配置 option
• 配置 option 的参数
• 获取配置 option 参数

#!/usr/bin/env node

// // dev-log >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
console.log(`[Dev_Log][${"执行cli_sest"}_]_>>>`);

const commander = require("commander");
const pkg = require("../package.json");

// 创建commander的单个实例
const program = new commander.Command();

program
  .name(Object.keys(pkg.bin)[0]) // 命令名称
  .usage("<command> [options]") // 提示
  .version(pkg.version) // 版本
  .option("-d, --debug", "是否开启调试模式", false) // 选项 描述 默认值
  .option("-e, --envName <envName>", "获取环境变量名称") // 选项 <参数> 描述
  .parse(process.argv); // 输入参数options&paardm解析

// dev-log >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
/** program._optionValues 或者 program.opts() 可以打印当前所有的 option 对象中的值 */
console.log(`[Dev_Log][${"program"}_]_>>>`, program._optionValues);
console.log(`[Dev_Log][${"program"}_]_>>>`, program.opts());

/** 打印帮助信息 */
program.outputHelp();

命令注册

有两种方式

• command
• addCommand

#!/usr/bin/env node

const commander = require("commander");
const pkg = require("../package.json");

/**
 * 创建commander的单个实例
 * */
const program = new commander.Command();

/**
 * 执行
 * */
program
  .name(Object.keys(pkg.bin)[0]) // 命令名称
  .usage("<command> [options]") // 提示
  .version(pkg.version) // 版本
  .option("-d, --debug", "是否开启调试模式", false) // 选项 描述 默认值
  .option("-e, --envName <envName>", "获取环境变量名称"); // 选项 <参数> 描述

/**
 * command 注册命令 (方式一)
 * */
program
  .command("clone <source> [destination]") // <>必填、 []选填  // usage：cli_test clone sUrl dUrl
  .description("clone a repository into a newly created directory")
  .option("-f, --force", "是否强制克隆") // usage：cli_test clone sUrl dUrl -f
  .action((source, destination, commandOpt) => {
    console.log("clone command called", {
      source,
      destination,
      commandOpt,
    });
  });

/**
 * addCommand 注册命令&注册子命令 (方式二)
 *  */
const service = new commander.Command("service");

service
  .command("start [port]") // usage：cli_test service start 999
  .description("start service at [port]")
  .action((port) => {
    console.log("service start called", port);
  });

service
  .command("stop") // usage：cli_test service stop
  .description("stop service")
  .action((port) => {
    console.log("stop service");
  });

program.addCommand(service);

/**
 * 拼接命令用于执行其他库的命令
 */
// usage：[cli_test n list | cli_test i list ] equal [npm list]
// program
//   .command("n [name]", "n package", {
//     executableFile: "npm", // 指定要执行的命令别名
//     isDefault: true, // 忽略 program.arguments 检测
//     hidden: true, // 隐藏在帮助信息中command的打印显示（内部调试命令可设置）
//   })
//   .alias("i");

/**
 * 匹配所有输入的命令并检测
 */
// program
//   .arguments("<command> [options]")
//   .description(" parsed options and the command object itself", {
//     cmd: "command to run",
//     options: "options for command",
//   })
//   .action(function (command, options) {
//     console.log("command", options);
//   });

/**
 * 传入命令行的参数
 * */
program.parse(process.argv); // 输入参数options&paardm解析

/**
 * dev-log
 * */
// // program._optionValues 或者 program.opts() 可以打印当前所有的 option 对象中的值
// console.log(`[Dev_Log][${"program"}_]_>>>`, program);
// console.log(`[Dev_Log][${"program"}_]_>>>`, program._optionValues);
// console.log(`[Dev_Log][${"program"}_]_>>>`, program.opts());

// // 打印帮助信息
// program.outputHelp()