用JS打造命令行工具:Node.js实战教学
时间:2026-03-20 13:39:33 154浏览 收藏
想摆脱浏览器束缚,让JavaScript在终端大显身手?本文手把手带你用Node.js打造属于自己的命令行工具——从初始化项目、添加shebang声明和package.json的bin配置,到用yargs优雅解析参数、通过npm link本地调试,再到实现greet问候、create文件等实用命令,全程零基础可上手,最后还能一键发布到npm供全球开发者使用,真正让JS成为你自动化工作流中的利器。

想用 JavaScript 和 Node.js 实现一个命令行工具?其实并不难。Node.js 提供了完整的系统能力,可以轻松读取命令行参数、执行操作并输出结果。下面一步步教你如何从零开始创建一个简单的 CLI 工具。
1. 初始化项目
打开终端,创建项目目录并初始化 npm:
- mkdir my-cli-tool
- cd my-cli-tool
- npm init -y
这会生成 package.json 文件,是 Node.js 项目的配置核心。
2. 创建主脚本文件
新建一个 index.js 作为入口文件:
#!/usr/bin/env node
console.log('Hello from your CLI tool!');
第一行 #!/usr/bin/env node 是“shebang”,告诉系统这个文件要用 Node.js 执行。这是制作可执行脚本的关键。
3. 配置 package.json 可执行命令
修改 package.json,添加 bin 字段:
{
"name": "my-cli-tool",
"version": "1.0.0",
"bin": {
"mytool": "./index.js"
},
"preferGlobal": true
}
这样安装后就能通过 mytool 命令调用你的脚本。
4. 解析命令行参数
Node.js 的 process.argv 可以获取输入的参数。例如:
const args = process.argv.slice(2);
if (args[0] === 'greet') {
console.log('Hi there,', args[1] || 'Guest');
}
运行 node index.js greet Alice 会输出:Hi there, Alice。
更推荐使用第三方库如 yargs 或 commander 来处理复杂逻辑。
安装 yargs:
npm install yargs
更新 index.js:
#!/usr/bin/env node
const yargs = require('yargs');
yargs
.command('greet <name>', 'Say hello', (yargs) => {
yargs.positional('name', {
describe: 'Who to greet',
type: 'string'
});
}, (argv) => {
console.log(`Hello, ${argv.name}!`);
})
.help()
.argv;
现在运行 mytool greet John 就能看到问候信息。
5. 全局安装与使用
在项目目录下运行:
npm link
这条命令会把你的工具软链接到全局环境,之后就可以直接使用 mytool 命令了。
如果要发布到 npm,运行 npm publish(需要注册账号),别人就能通过 npm install -g my-cli-tool 安装使用。
6. 添加更多功能示例
比如添加一个生成文件的命令:
const fs = require('fs');
yargs
.command('create <filename> [content]', 'Create a file', (yargs) => {
yargs
.positional('filename', { type: 'string' })
.positional('content', { type: 'string', default: 'Hello!' });
}, (argv) => {
fs.writeFileSync(argv.filename, argv.content);
console.log(`${argv.filename} created.`);
})
运行 mytool create note.txt "This is cool" 就会生成文件。
基本上就这些。你可以继续扩展命令、加颜色输出(用 chalk 库)、支持配置文件等。Node.js 让 JS 不只跑在浏览器里,也能成为强大的脚本语言。
以上就是《用JS打造命令行工具:Node.js实战教学》的详细内容,更多关于的资料请关注golang学习网公众号!
-
502 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
243 收藏
-
440 收藏
-
432 收藏
-
103 收藏
-
348 收藏
-
156 收藏
-
439 收藏
-
223 收藏
-
372 收藏
-
501 收藏
-
283 收藏
-
388 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习