每日分享- nodejs 如何通过 npm 写一个 cli 命令行工具?

通过 npm 可以轻松地创建并发布一个命令行工具。下面是一个简单的示例，用于创建一个名为 mycli 的命令行工具。

1 初始化 npm 项目

首先需要在本地创建一个新的 npm 项目。在终端中执行以下命令：

mkdir mycli
cd mycli
npm init

按照提示输入项目相关信息，如名称、版本号、描述等。其中，需要注意设置 "bin" 字段，用于指定工具的入口文件路径。

例如，可以将入口文件命名为 cli.js，并在 package.json 文件中添加以下字段：

"bin": {
  "mycli": "./cli.js"
}

这表示将 cli.js 文件作为 mycli 命令的入口文件。

2 编写命令行工具入口文件

在项目根目录下创建 cli.js 文件，用于编写命令行工具的代码。以下是一个简单的示例：

#!/usr/bin/env node

console.log('Hello from mycli!');

其中，第一行 #!/usr/bin/env node 表示使用系统的 Node.js 环境来执行这个脚本。接下来的代码表示在命令行工具运行时输出一条信息。

3 安装依赖

如果在编写命令行工具时需要使用第三方依赖库，可以在项目根目录下执行以下命令安装依赖：

npm install <dependency> --save

其中，<dependency> 表示要安装的依赖库名称。

4 发布命令行工具

发布命令行工具需要在 npm 上注册账号，并登录到 npm 帐户中。在终端中执行以下命令进行登录：

npm login

登录成功后，执行以下命令将命令行工具发布到 npm 上：

npm publish

注意：在首次发布工具之前，需要先执行 npm init 命令初始化项目，并设置好 package.json 文件中的相关字段。

5 使用命令行工具

在命令行中执行以下命令，即可使用刚才创建的命令行工具：

mycli

执行结果会输出 Hello from mycli!。此时，命令行工具已经成功创建并发布。可以继续扩展代码，添加更多的功能。