从浅入深讲解 Node 如何开发一个命令行工具

发布时间：2025-11-05 10:40:34 来源：创站工坊 作者：系统运维

最近山月开发了一个从任意 URL 解析内容并生成 markdown 的从浅小客户端工具: markdown-read。用以我个人公众号的入深内容获取及一些优质内容的整理收藏，欢迎 Star、讲解具下载及使用。何开

$ markdown https://juejin.cn/post/6924258563862822919 | head -10 > 本文作者：Wind、命令Skyler、行工ZRJ、从浅ZJ ## 前言 Webpack5 在 2020 年 10 月 10 日正式发布，入深并且在过去的讲解具几个月中快速演进和迭代，截止 1 月 28 日，何开Webpack5 已经更新了 18 个 minor 版本，命令带来了许多十分吸引人的行工新特性。据[官网介绍](https://webpack.js.org/blog/2020-10-10-webpack-5-release/#general-direction "官网介绍")，从浅Webpack5 整体的入深方向性变化有以下几点：  +   通过持久化硬盘缓存能力来提升构建性能 +   通过更好的算法来改进长期缓存（降低产物资源的缓存失效率） 

想到用 Node 开发一个命令行工具在工作中也较为常见，也很有意思，讲解具总结一下

命令行工具

什么是命令行工具?

最初印象大致是 ls，pwd 这些能够在终端执行的系统命令，这样的命令有很多，数不胜数，被称为系统内置命令。如果使用 which 查看他们的来历，WordPress模板则能够发现他们的庐山真面目:

随着对 Linux/Unix 系统理解及使用的逐渐加深，发现了诸多的非内置命令:

使用 which 侦查情况，发现他们实际执行的路径在某一个 bin 目录

而这些 bin 目录在环境变量 PATH 中，豁然开朗。简而言之: 在 PATH 中路径的命令可在其它任意地方执行。

你好像想起点什么?在大学配置 Java 时被环境变量支配的各种恐惧?是了，所有语言的可执行命令都要放在 PATH 下，只不过其它语言自动给你做了，而 Java 让你自己做这件事。

开发命令行的原理也是如此，而本篇文章的目标就是:

使用 Javascript 这门前端开发者熟悉的语言，借助 Node 环境，开发一个命令行工具。

原理

先看两个命令行工具: serve 一个流行的静态文件服务器，markdown 一个我自己写的解析 URL 到 markdow 的命令行。通过命令解析出他们指向的符号链接

从中可以看出他们关于命令行的网站模板解析:

简而言之，Node 环境下的命令行工具，借助的原理无非是环境变量 Path 与一个符号链接

从 package.json 说起

在 package.json 中的 bin 选项，用以指定最终的命令行工具的名字

如上所示，markdown 是最终在终端执行的命令，而 ./md-read-cli 是该命令实际执行的文件。

对于最终可执行的命令行工具，Node 项目一般倾向置文件于 bin 目录下，如以下 Typescript 的配置:

一个执行环境

对于可直接执行的文件，需要指明执行环境，首行添加一行说明:

这一句话是啥子意思了?

所以这句话的意思是: 使用 node 执行这个脚本

解析命令输入

根据解析 process.argv 来获取各式各样的参数作为命令行的输入，当然解析参数也要参照基本规律: 格式、可选、必选、简写、说明、帮助等等。命令行工具命名协议 文章中已说的足够详细。

以此衍生出了关于解析命令参数的多个库，在实际工作中就直接用吧!

使用 commander 解析不同的输入指令

丰富的色彩体验

Next 构建输出

目前大部分终端已支持彩色输出，丰富的高亮色彩如同代码高亮一样使用户可以快速抓住重点。把异常、警告、成功的信息用不同的颜色标出，命令行工具的输出一目了然。在现代构建工具，如 Webpack 下，也大都支持彩色输出。

以下是在命令行工具中常用的两个色彩库，支持多种多样色彩的输出。

以下是 chalk 示例，Error 与 Warning 信息用不同的颜色表示

发布与安装

在辛苦努力写完一个 cli 工具后，就是检验成果的时候。发布到 npm 仓库，可使所有人使用你的命令行工具，这也是最重要的一步

发版成功后全局下载命令行工具，开始使用，示例用它抓取下我的博客首页

总结

本篇文章由浅至深讲解了以下几方面的内容:

并根据实践，开发了一个从 URL 中读取 Markdown 的小工具: markdown-read，欢迎 Star、下载及使用。

另外，我基于此命令行做了一个 Web 版，欢迎来体验: https://devtool.tech/html-md

本文转载自微信公众号「全栈成长之路」，可以通过以下二维码关注。转载本文请联系全栈成长之路公众号。

相关文章