Node.js 命令行程序开发教程

作者: 阮一峰

日期: 2015年5月26日

一种编程语言是否易用,很大程度上,取决于开发命令行程序的能力。

Node.js 作为目前最热门的开发工具之一,怎样使用它开发命令行程序,是 Web 开发者应该掌握的技能。

最近,Npm的网志有一组系列文章,我觉得写得非常好。下面就是我在它的基础上扩展的教程,应该是目前最好的解决方案了。

一、可执行脚本

我们从最简单的讲起。

首先,使用 JavaScript 语言,写一个可执行脚本 hello 。


#!/usr/bin/env node
console.log('hello world');

然后,修改 hello 的权限。


$ chmod 755 hello

现在,hello 就可以执行了。


$ ./hello
hello world

如果想把 hello 前面的路径去除,可以将 hello 的路径加入环境变量 PATH。但是,另一种更好的做法,是在当前目录下新建 package.json ,写入下面的内容。


{
  "name": "hello",
  "bin": {
    "hello": "hello"
  }
}

然后执行 npm link 命令。


$ npm link

现在再执行 hello ,就不用输入路径了。


$ hello
hello world

二、命令行参数的原始写法

命令行参数可以用系统变量 process.argv 获取。

下面是一个脚本 hello 。


#!/usr/bin/env node
console.log('hello ', process.argv[2]);

执行时,直接在脚本文件后面,加上参数即可。


$ ./hello tom
hello tom

上面代码中,实际上执行的是 node ./hello tom ,对应的 process.argv 是 ['node', '/path/to/hello', 'tom'] 。

三、新建进程

脚本可以通过 child_process 模块新建子进程,从而执行 Unix 系统命令。


#!/usr/bin/env node
var name = process.argv[2];
var exec = require('child_process').exec;

var child = exec('echo hello ' + name, function(err, stdout, stderr) {
  if (err) throw err;
  console.log(stdout);
});

用法如下。


$ ./hello tom
hello tom

四、shelljs 模块

shelljs 模块重新包装了 child_process,调用系统命令更加方便。它需要安装后使用。


npm install --save shelljs

然后,改写脚本。


#!/usr/bin/env node
var name = process.argv[2];
var shell = require("shelljs");

shell.exec("echo hello " + name);

上面代码是 shelljs 的本地模式,即通过 exec 方法执行 shell 命令。此外还有全局模式,允许直接在脚本中写 shell 命令。


require('shelljs/global');

if (!which('git')) {
  echo('Sorry, this script requires git');
  exit(1);
}

mkdir('-p', 'out/Release');
cp('-R', 'stuff/*', 'out/Release');

cd('lib');
ls('*.js').forEach(function(file) {
  sed('-i', 'BUILD_VERSION', 'v0.1.2', file);
  sed('-i', /.*REMOVE_THIS_LINE.*\n/, '', file);
  sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, cat('macro.js'), file);
});
cd('..');

if (exec('git commit -am "Auto-commit"').code !== 0) {
  echo('Error: Git commit failed');
  exit(1);
}

五、yargs 模块

shelljs 只解决了如何调用 shell 命令,而 yargs 模块能够解决如何处理命令行参数。它也需要安装。


$ npm install --save yargs

yargs 模块提供 argv 对象,用来读取命令行参数。请看改写后的 hello 。


#!/usr/bin/env node
var argv = require('yargs').argv;

console.log('hello ', argv.name);

使用时,下面两种用法都可以。


$ hello --name=tom
hello tom

$ hello --name tom
hello tom

也就是说,process.argv 的原始返回值如下。


$ node hello --name=tom
[ 'node',
  '/path/to/myscript.js',
  '--name=tom' ]

yargs 可以上面的结果改为一个对象,每个参数项就是一个键值对。


var argv = require('yargs').argv;

// $ node hello --name=tom
// argv = {
//   name: tom
// };

如果将 argv.name 改成 argv.n,就可以使用一个字母的短参数形式了。


$ hello -n tom
hello tom

可以使用 alias 方法,指定 name 是 n 的别名。


#!/usr/bin/env node
var argv = require('yargs')
  .alias('n', 'name')
  .argv;

console.log('hello ', argv.n);

这样一来,短参数和长参数就都可以使用了。


$ hello -n tom
hello tom
$ hello --name tom
hello tom

argv 对象有一个下划线(_)属性,可以获取非连词线开头的参数。


#!/usr/bin/env node
var argv = require('yargs').argv;

console.log('hello ', argv.n);
console.log(argv._);

用法如下。


$ hello A -n tom B C
hello  tom
[ 'A', 'B', 'C' ]

六、命令行参数的配置

yargs 模块还提供3个方法,用来配置命令行参数。

  • demand:是否必选
  • default:默认值
  • describe:提示

#!/usr/bin/env node
var argv = require('yargs')
  .demand(['n'])
  .default({n: 'tom'})
  .describe({n: 'your name'})
  .argv;

console.log('hello ', argv.n);

上面代码指定 n 参数不可省略,默认值为 tom,并给出一行提示。

options 方法允许将所有这些配置写进一个对象。


#!/usr/bin/env node
var argv = require('yargs')
  .option('n', {
    alias : 'name',
    demand: true,
    default: 'tom',
    describe: 'your name',
    type: 'string'
  })
  .argv;

console.log('hello ', argv.n);

有时,某些参数不需要值,只起到一个开关作用,这时可以用 boolean 方法指定这些参数返回布尔值。


#!/usr/bin/env node
var argv = require('yargs')
  .boolean(['n'])
  .argv;

console.log('hello ', argv.n);

上面代码中,参数 n 总是返回一个布尔值,用法如下。


$ hello
hello  false
$ hello -n
hello  true
$ hello -n tom
hello  true

boolean 方法也可以作为属性,写入 option 对象。


#!/usr/bin/env node
var argv = require('yargs')
  .option('n', {
    boolean: true
  })
  .argv;

console.log('hello ', argv.n);

七、帮助信息

yargs 模块提供以下方法,生成帮助信息。

  • usage:用法格式
  • example:提供例子
  • help:显示帮助信息
  • epilog:出现在帮助信息的结尾

#!/usr/bin/env node
var argv = require('yargs')
  .option('f', {
    alias : 'name',
    demand: true,
    default: 'tom',
    describe: 'your name',
    type: 'string'
  })
  .usage('Usage: hello [options]')
  .example('hello -n tom', 'say hello to Tom')
  .help('h')
  .alias('h', 'help')
  .epilog('copyright 2015')
  .argv;

console.log('hello ', argv.n);

执行结果如下。


$ hello -h

Usage: hello [options]

Options:
  -f, --name  your name [string] [required] [default: "tom"]
  -h, --help  Show help [boolean]

Examples:
  hello -n tom  say hello to Tom

copyright 2015

八、子命令

yargs 模块还允许通过 command 方法,设置 Git 风格的子命令。


#!/usr/bin/env node
var argv = require('yargs')
  .command("morning", "good morning", function (yargs) {
    console.log("Good Morning");
  })
  .command("evening", "good evening", function (yargs) {
    console.log("Good Evening");
  })
  .argv;

console.log('hello ', argv.n);

用法如下。


$ hello morning -n tom
Good Morning
hello tom

可以将这个功能与 shellojs 模块结合起来。


#!/usr/bin/env node
require('shelljs/global');
var argv = require('yargs')
  .command("morning", "good morning", function (yargs) {
    echo("Good Morning");
  })
  .command("evening", "good evening", function (yargs) {
    echo("Good Evening");
  })
  .argv;

console.log('hello ', argv.n);

每个子命令往往有自己的参数,这时就需要在回调函数中单独指定。回调函数中,要先用 reset 方法重置 yargs 对象。


#!/usr/bin/env node
require('shelljs/global');
var argv = require('yargs')
  .command("morning", "good morning", function (yargs) {  
    echo("Good Morning");
    var argv = yargs.reset()
      .option("m", {
        alias: "message",
        description: "provide any sentence"
      })
      .help("h")
      .alias("h", "help")
      .argv;

    echo(argv.m);
  })
  .argv;

用法如下。


$ hello morning -m "Are you hungry?"
Good Morning
Are you hungry?

九、其他事项

(1)返回值

根据 Unix 传统,程序执行成功返回 0,否则返回 1 。


if (err) {
  process.exit(1);
} else {
  process.exit(0);
}

(2)重定向

Unix 允许程序之间使用管道重定向数据。


$ ps aux | grep 'node'

脚本可以通过监听标准输入的data 事件,获取重定向的数据。


process.stdin.resume();
process.stdin.setEncoding('utf8');
process.stdin.on('data', function(data) {
  process.stdout.write(data);
});

下面是用法。


$ echo 'foo' | ./hello
hello foo

(3)系统信号

操作系统可以向执行中的进程发送信号,process 对象能够监听信号事件。


process.on('SIGINT', function () {
  console.log('Got a SIGINT');
  process.exit(0);
});

发送信号的方法如下。


$ kill -s SIGINT [process_id]

(完)

珠峰培训

一灯学院

留言(26条)

谢谢整理

很喜欢阅读阮老师的文章,已经向周围同事和同学推荐了。简约而不简单。

事实上我经常用 commander 模块开发命令行工具。

个人感觉,yargs 比 commander 功能多了一点点,而且写起来容易看清楚逻辑。

请问可以在windows下面用node.js做命令行吗?

引用swizard的发言:

请问可以在windows下面用node.js做命令行吗?

node.js 内置了 process.argv 用于访问参数列表,这是跨平台的。
只不过为了方便,我们可以借助于专门的模块来做 parser,比如 commander 和这里提到的 yargs,从控制台读入可以用 readline 等模块。

使用类似的方法,在 Windows 上也很容易,不过我没有试过 npm link。

非常喜欢读阮老师的文章, 谢谢!

请教下有没有相关的插件可以把一行字符串当作一句命令来分析?

阮老师好:
我在通过你的blog学习node。
我刚刚看完第一个例子,我安装了node,写了hello,赋权限,“./hello”控制台成功现实,继续,我在使用npm link 命令加载package.json的时候,程序异常了
--

pm ERR! Error: EACCES, symlink '/Users/Yang/Project/NodeFactory/Test1'
npm ERR! at Error (native)
npm ERR! { [Error: EACCES, symlink '/Users/Yang/Project/NodeFactory/Test1']
npm ERR! errno: -13,
npm ERR! code: 'EACCES',
npm ERR! path: '/Users/Yang/Project/NodeFactory/Test1' }
npm ERR!
npm ERR! Please try running this command again as root/Administrator.

npm ERR! Please include the following file with any support request:
npm ERR! /Users/Yang/Project/NodeFactory/Test1/npm-debug.log

--
我自己尝试解决了下问题,但没成功,请问老师,这个是什么原因?

@精神阳:

权限问题,加上sudo就可以

$ sudo npm link

但是,npm不应该与sudo一起使用
https://docs.npmjs.com/getting-started/fixing-npm-permissions

首先感谢阮老师回复我的提问(PS:真没想到阮老师会回复,有些感动)
我看了软老师给我提供的资料连接(https://docs.npmjs.com/getting-started/fixing-npm-permissions)
由于我的npm路径在“/usr”下,为了不影响其他文件的访问权限控制,我按资料中的提示,修改了npm的默认路径
--
➜ Test1 hello
hello world
➜ Test1
--
目前以完成练习1的内容,我会继续学习
最后感谢阮老师的文章

我也用 commander

原来node还可以这么玩

http://www.skylerzhang.com/node/2015/01/08/commandline/

我之前翻译的文章,也是node做命令行的

引用yumy的发言:

请教下有没有相关的插件可以把一行字符串当作一句命令来分析?

用这个: process.arg.slice(2).join('')

阮老师好,我学习node还没多久,由于工作有些忙,进度有些慢。
最近我遇到一个很麻烦的问题,想了好久没什么头绪。
是这样的:
当我遍历一个目录(目录下有多个文件),然后使用fs.readFile异步读取目录下的文件。
出题出现,当我在异步回调函数中操作读取到的内容的时候,我需要用这个读取当前文件的文件名称,但因为是异步,导致回调函数执行的时候,我的读文件操作早已结束,这意味着我拿到的是最后读取的那个文件的名称,而不是我想要的,readFile中也不能自定义参数传递进去,请问阮老师,这种情况我应该怎么处理?

引用阮一峰的发言:

@精神阳:

权限问题,加上sudo就可以

$ sudo npm link

但是,npm不应该与sudo一起使用
https://docs.npmjs.com/getting-started/fixing-npm-permissions

这样写,似乎不需要sudo
{
"name": "hello",
"bin": {
"hello": "hello.js"
}
}

demo12我装了包,node server.js 控制台也输出了Listening on 3000...,但是在浏览器中输入http://127.0.0.1:3000/报网络错误,这是怎么回事呢

峰哥,我有个问题,为什么需要使用命令行开发程序。应用场景是什么?能不能举个例子?

引用penergy的发言:

峰哥,我有个问题,为什么需要使用命令行开发程序。应用场景是什么?能不能举个例子?

比如,你要把一个文件夹内的所有文件,按特定的规则重命名,然后将这些文件拷贝到另外一个文件夹下。怎么做?

我在mac命令行的hashbang要这样写才行
#! /usr/local/bin/node

阮哥,如何在node.js里面调用'shutdown -s -t 0' 来让系统关机

第七点:
前面写了option('f' ...
后面输出 又是 argv.n

谢谢阮老师写了那么棒的文章,我根据你的文章写了个脚本,然后想要通过npm link 链接至bin下,我的package.json是这样的:
{
"name": "build",
"bin": {
"build": "build"
}
}
------------

以下是npm link后的输出:

npm WARN build@ No description
npm WARN build@ No repository field.
npm WARN build@ No license field.
/usr/local/bin/build -> /usr/local/lib/node_modules/build/build
/usr/local/lib/node_modules/build -> /Users/Programer/Desktop/build_script
------------
然后我命令行运行build,输出以下:
/usr/local/bin/build: line 1: syntax error near unexpected token `'shelljs/global''
/usr/local/bin/build: line 1: `require('shelljs/global');'
------------
我个人认为跟安装shelljs的路径有关系,以下是我shelljs的路径:
/usr/local/bin/shjs -> /usr/local/lib/node_modules/shelljs/bin/shjs
------------

我已经是全局安装了shelljs,为什么require不到shelljs模块呢,望老师指点一下~

帮助信息那个有误
应该输出是console.log(argv.f)

阮老师好:

node内部模块cluster 类似利用单机多cpu,启动多实例监听;是不是也用childProcess模块。

我要发表看法

«-必填

«-必填,不公开

«-我信任你,不会填写广告链接