用 JavaScript 构建命令行工具的关键是配置 shebang 行和 package.json 的 bin 字段,通过 npm link 或 publish 实现全局命令;使用 minimist 或 yargs 解析参数,读取 stdin 或 readline 处理输入,规范输出与退出码。

用 JavaScript 构建命令行工具不难,核心是让 Node.js 脚本能被系统识别为可执行命令,并支持参数解析和交互逻辑。
让脚本变成全局可用的命令
关键在于 package.json 的 bin 字段和文件顶部的 shebang 行。
- 在脚本开头加上 ##!/usr/bin/env node,告诉系统用 Node.js 执行它
- 在 package.json 中配置:
"bin": { "mytool": "./cli.js" } - 运行 npm link(开发时)或 npm publish(发布后),就能在终端直接输入 mytool 运行
解析命令行参数
用户输入的 mytool --input file.txt --verbose 需要被正确读取。推荐用 minimist 或 yargs。
-
minimist 轻量,适合简单需求:
const args = require('minimist')(process.argv.slice(2));
console.log(args.input); // 'file.txt' - yargs 功能强,自带帮助提示、类型校验、子命令支持
读取标准输入与交互
处理管道输入(如 cat data.json | mytool)或用户交互(如提问确认)需要操作 process.stdin。
MixPHP 是一个 PHP 命令行模式开发框架;基于 Vega 驱动的 HTTP 可以同时支持 Swoole、WorkerMan、FPM、CLI-Server 生态,并且可以无缝切换;V3 是一个高度解耦的版本,整体代码基于多个独立的模块构建,即便用户不使用我们的脚手架,也可以使用这些独立模块,并且全部模块都支持原生开发。例如:你可以只使用 mix/vega 来搭配 laravel orm 使用
立即学习“Java免费学习笔记(深入)”;
- 判断是否有管道输入:
if (!process.stdin.isTTY) { /* 读取 stdin 流 */ } - 读取用户输入(同步):
const readline = require('readline');
const rl = readline.createInterface({ input: process.stdin });
rl.question('Continue? (y/n) ', answer => { /* 处理回答 */ });
输出结构化结果与退出码
命令行工具应清晰反馈结果,并用退出码表达状态(0=成功,非0=错误)。
- 正常结束:不用额外操作,默认退出码为 0
- 出错时显式退出:
console.error('File not found');
process.exit(1); - 输出 JSON 便于其他程序解析(加 --json 选项时)
基本上就这些。不复杂但容易忽略 shebang 和 bin 配置,写完记得本地 link 测试再发布。









