javascript如何实现命令行工具_怎样用Node.js编写脚本

Node.js 命令行工具需在文件首行添加 #!/usr/bin/env node,设执行权限,用 process.argv.slice(2) 或 commander 解析参数;通过 bin 字段配置并 npm link 可实现全局命令。

用 Node.js 写命令行工具,核心是让 JS 文件能像 shell 命令一样直接执行——关键在于文件开头加 #!/usr/bin/env node、设好执行权限、并通过 process.argv 或更友好的库(如 commander)解析参数。

让脚本可直接运行

在 JS 文件顶部加上 shebang 行,告诉系统用 node 执行它:

#!/usr/bin/env node
console.log('Hello from CLI!');

保存为 mycli.js,然后赋予执行权限:

chmod +x mycli.js

之后就能直接运行:

./mycli.js --help

如果想全局当作命令用(比如直接输 mycli),可以把文件重命名为 mycli(去掉 .js),并放到 /usr/local/bin/ 或通过 npm link 注册。

获取和解析命令行参数

Node.js 原生提供 process.argv,它是一个数组,前两个元素固定为 node 路径和脚本路径,后续才是用户输入的参数:

  • node script.js foo bar --flagprocess.argv['node', 'script.js', 'foo', 'bar', '--flag']
  • 通常用 process.argv.slice(2) 拿到真正参数
  • 手动解析较麻烦,推荐用成熟库简化逻辑

用 commander 管理命令和选项

commander 是最常用的 CLI 工具库,支持子命令、选项、自动帮助文档:

npm install commander

示例(deploy.js):

#!/usr/bin/env node
const { Command } = require('commander');
const program = new Command();

program
  .name('deploy')
  .description('Deploy app to env')
  .version('1.0.0');

program
  .command('prod')
  .description('Deploy to production')
  .option('-f, --force', 'Force deploy')
  .action((options) => {
    console.log('Deploying to prod...', options.force ? '(forced)' : '');
  });

program.parse();

运行效果:

  • ./deploy.js prod --force → 输出带 "(forced)"
  • ./deploy.js --help → 自动输出结构化帮助信息

发布成 npm 全局命令(可选)

想让别人安装后直接用命令(如 npx create-appnpm install -g mycli),需在 package.json 中配置 bin 字段:

{
  "name": "mycli",
  "version": "0.1.0",
  "bin": {
    "mycli": "./index.js"
  },
  "engines": {
    "node": ">=14"
  }
}

确保 index.js 有 shebang 并可执行。发布前本地测试:npm link,即可全局使用 mycli 命令。