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

Club

2015-07-14

关注关注

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

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

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

最近，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 获取。

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

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

$ ./hello tom
hello tom

三、新建进程

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

#!/usr/bin/env node
var name = process.argv[2];
varexec=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

如果将 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
GoodMorning
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?"
GoodMorning
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]

下面的内容你可能也喜欢：

Node.js 的详细介绍：请点这里
Node.js 的下载地址：请点这里

命令行教程

Club

0 关注 0 粉丝 0 动态

关注关注

命令行生存指南：强制早睡

你会不会经常陷入这么一个情景：计划晚上早点睡叫，然而无奈总是一不小心玩过头了。你需要一种方法强制让你到时间了就要关机去睡觉了，这该怎么做呢？Kgotobed 是一个很变态的内核模块。它会强制 Linux 在特定时间关闭，而你却毫无办法。内核模块允许 Lin

吹云 2020-11-05

命令行生存指南：监视命令输出

有时候需要不断的执行某个命令并追踪其输出产生的变化情况。一种常见的方法是通过写一段死循环的 shell 脚本来实现，不过 Linux 本身已经提供了一个工具来帮你定期执行指定的程序并将结果全屏输出，本节将会介绍该工具。进程将从标准输入文件中得到输入数据，将

84407805 2020-11-01

使用curl从命令行访问互联网

下载我们整理的 curl 备忘录。要在不使用图形界面的情况下从互联网上获取所需的信息，curl 是一种快速有效的方法。curl通常被视作一款非交互式 Web 浏览器，这意味着它能够从互联网上获取信息，并在你的终端中显示，或将其保存到文件中。从表面看，这是

曾是土木人 2020-10-31

在Linux命令行内的大小写转换

在编辑文本时大小写常常是需要注意的地方，大小写的转换是很枯燥而繁琐的工作，所幸，Linux 提供了很多能让这份工作变得容易的命令。接下来让我们看看都有哪些完成大小写转换的命令。tr 是能运用在命令行或者脚本上的最简单的大小写转换命令之一。例如如果你想

87201442 2020-10-15

程序员直呼瑞思拜！这7个命令行工具你还没尝试过吗？

本文转载自公众号“读芯术”。终端/命令行是可能是程序员最常用的工具。这或许是因为它是轻量型的，可以用来做很多事，一些开发人员甚至不遗余力地在终端内部进行操作。本文将分享一些我每天都会大量使用的CLI工具。有哪种终端机列表不包含vim?对于那些不熟悉vim的

java0 2020-09-29

GitHub命令行工具1.0版正式上线，从此告别网页管理

经过大半年的迭代与完善，今天GitHub CLI已经成功从beta版升级为1.0正式版，可供所有用户使用。GitHub CLI让开发者在终端里使用命令行管理代码项目，不必打开网页，工作效率更高。GitHub在官方博客中表示，自年初发布测试版以来，用户使用G

81437716 2020-09-18

提升开发效率N倍的20+命令行神器，赶紧收藏了

è¨°é¨°poé “Shell ”éè“¤è”èéè° Shell ¨èè Linux è Mac ¨··¤¤。éèè¤è§é¨¤· è·°éè°èè°éè¨° cmd --help è man cmd¨¤¨¤°±èè°。nginx è¤ HTTP

81437716 2020-09-13

在命令行中使用nmcli来管理网络连接

nmcli 命令赋予你直接在 Linux 命令行操作 NetworkManager 工具的能力。它是 NetworkManager 软件包集成的一部分，通过使用一些应用程序接口来获取 NetworkManager 的功能。nmcli发布于 2010 年，用

bluecarrot 2020-09-11

在 Linux 命令行里与其他用户通信

在 Linux 命令行里向其他用户发送信息很简单，很多命令都可以做到这点，麻烦的是你需要从众多命令中挑选一个合适的命令来使用。因此，我挑选了四种常用的 Linux 用户通信命令分享给大家并为你们讲解这四种命令是如何工作的。wall 命令允许你向所有在系统

myCat 2020-09-09

命令行版的斗地主你玩过没？

相信大家都玩过斗地主游戏，或在现实中斗地主或在电脑和手机上斗地主，但你想过用命令行界面进行斗地主吗?是不是觉得挺有意思，下面就带大家一起玩一下吧~该项目是基于java开发的，因此需要部署java运行环境及 maven。你可以创建私人服务器与好友一起斗地主，

83427718 2020-09-07

使用命令行工具 Graudit 来查找你代码中的安全漏洞

测试是软件开发生命周期的重要组成部分，它有几个阶段。今天，我想谈谈如何在代码中发现安全问题。这就是为什么有一个术语叫 DevSecOps，它的基本职责是识别和解决应用中的安全漏洞。有一些用于检查 OWASP 漏洞的开源解决方案，它将通过创建源代码的威胁模

85560694 2020-09-03

在Linux命令行中使用计算器的5个命令

大家好，我是良许。在使用 Linux 时，我们有时会需要做一些计算，那么我们就可能需要用到计算器。在 Linux 命令行里，有许多计算器工具，这些命令行计算器可以让我们执行科学计算、财务计算或者一些简单的计算。当然，我们也可以在 Shell 脚本中使用

89520991 2020-08-21

5款超级好用的命令行工具，提升你的开发效率！

如果你是一个喜欢使用Linux系统，或者经常和Linux打交道的开发人员。那么，终端和命令行一定是接触很频繁的工具之一。Linux不像Windows那样，有丰富的桌面应用，但是，却有很多开源、免费的命令行工具，这也恰好符合Linux的应用场景。找到一款优秀

89550191 2020-08-09

Linux系统中玩到让你停不下来的命令行游戏！

在使用 Linux 系统时，命令行不仅可以让我们在工作中提高效率，它还可以在生活上给我们提供各种娱乐活动，因为你可以使用它玩许多非常有意思的游戏，这些游戏可都不需要使用专用显卡。命令行游戏尽管比较简单，看上去只是一行行枯燥的代码，但有，还是有不少的 Lin

katie000 2020-08-04

终端命令行生存之——网络冲浪篇

Linux命令行是强大的工具，命令行是我们的日常工作，命令行更是我们日常生活。之前虫虫给大家写过一些命令的的介绍，命令行的工具，命令行下的开发。实际上命令行也是我们不可或缺的生活。本文我们来介绍一下命令行下的网络冲浪工具命令行浏览器。lynx一个历史悠久纯

hunningtu 2020-07-30

Github标星24.1K！一个命令行就可以把网站变成电脑App

现如今，我们大多数人都拥有多台设备，至少用两个系统，除非你对苹果生态系统十分着迷，否则这些设备没有办法达到你想象中的那样无缝协作，尽管人们一直致力于不同设备之间的沟通差距。例如许多应用程序是为计算机准备的，即便你离开手机也可以使用。有时候开发人员只是发布一

89961330 2020-07-28

Unix命令行中的Ctrl + Z和Ctrl + C的区别

Control+ Z用于通过向其发送信号来暂停进程，该信号SIGSTOP不能被程序拦截。而Control+ C用来杀死带有信号的进程SIGINT，并且可以被程序截获，因此它可以在退出之前清理自身，或者根本不退出。但是，如果您杀死了一个，则除了被退回到She

yuzhongdelei0 2020-07-28

使用git命令行撤销之前的代码更新提交

哈哈哈这样就大功告成了，也不是很麻烦哦！

ameng 2020-07-27

Windows下使用命令行编译Qt项目（解决DLL丢失问题）

我之前用Qt做了个hello world，结果各种报错，一大堆DLL找不到，今天用命令行编译就通过了

yuzhongdelei0 2020-07-27

Centos命令行报bash:.....:command not found的解决办法

命令行输入命令执行后报“bash:....:command not found”这是由于系统PATH设置问题，PATH没有设置对，系统就无法找到精确命令了。命令执行完之后先不要关闭终端。我的Linux系统是由于设置JAVA环境变量时设置PATH属性导致co

haitianisgood 2020-07-21

安科网

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

Club

一、可执行脚本

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

三、新建进程

四、shelljs 模块

五、yargs 模块

六、命令行参数的配置

七、帮助信息

八、子命令

九、其他事项

（1）返回值

（2）重定向

（3）系统信号

Club

相关推荐

命令行生存指南：强制早睡

命令行生存指南：监视命令输出

使用curl从命令行访问互联网

在Linux命令行内的大小写转换

程序员直呼瑞思拜！这7个命令行工具你还没尝试过吗？

GitHub命令行工具1.0版正式上线，从此告别网页管理

提升开发效率N倍的20+命令行神器，赶紧收藏了

在命令行中使用nmcli来管理网络连接

在 Linux 命令行里与其他用户通信

命令行版的斗地主你玩过没？

使用命令行工具 Graudit 来查找你代码中的安全漏洞

在Linux命令行中使用计算器的5个命令

5款超级好用的命令行工具，提升你的开发效率！

Linux系统中玩到让你停不下来的命令行游戏！

终端命令行生存之——网络冲浪篇

Github标星24.1K！一个命令行就可以把网站变成电脑App

Unix命令行中的Ctrl + Z和Ctrl + C的区别

使用git命令行撤销之前的代码更新提交

Windows下使用命令行编译Qt项目（解决DLL丢失问题）

Centos命令行报bash:.....:command not found的解决办法

Club