基于node的cli工具开发使用详解

什么是CLI工具

CLI指的是命令行界面，是与计算机进行交互的一种方式。CLI工具通常是指在命令行界面下运行的程序，可以执行一些简单的任务，比如新建文件夹、复制文件等等。CLI工具具有操作简便、灵活高效等特点，可以方便程序员进行开发工作。

CLI工具的开发流程

CLI工具的开发需要以下步骤：

1. 安装nodejs环境和npm包管理器
2. 创建工程目录
3. 初始化工程
4. 安装必要的依赖包
5. 在工程目录下创建命令行脚本
6. 编写脚本逻辑
7. 安装脚本为全局命令
8. 运行CLI工具

下面我们来详细介绍一下CLI工具的开发过程。

安装nodejs环境和npm包管理器

首先，我们需要在本地安装nodejs环境和npm包管理器，nodejs官网提供了各个平台的安装包和二进制文件下载：https://nodejs.org/。安装完成后，使用命令行工具查看是否安装成功，可以使用以下命令：

node -v

npm -v

如果以上两个命令能够顺利运行，就说明我们成功安装了nodejs和npm包管理器。

创建工程目录

在本地指定位置创建一个新的文件夹，用于存放我们的CLI工具开发相关文件。可以使用以下命令创建新的文件夹：

mkdir cli-tool

初始化工程

在命令行工具的当前目录下（也就是我们刚刚创建的cli-tool目录），使用以下命令初始化工程：

npm init -y

这个命令会根据我们输入的信息生成package.json文件，这个文件包含了我们工程的相关信息，比如名称、版本、依赖等等。

安装必要的依赖包

我们需要安装以下两个包：

• commander：这个包用于解析命令行参数
• chalk：这个包用于在命令行输出彩色的文字

可以使用以下命令进行安装：

npm install commander chalk --save

创建命令行脚本

在工程目录下创建一个文件，命名为cli.js。这个文件是我们的命令行脚本，用于解析命令行参数并执行相应的逻辑。

在这个文件中，我们需要引入commander包和chalk包，代码如下：

#!/usr/bin/env node

const program = require('commander');
const chalk = require('chalk');

program
  .version('1.0.0')
  .description('A CLI tool example')

这里我们使用了ES6的import语法来引入包，需要在package.json的配置文件中添加"type": "module"，以支持ES6语法。

编写脚本逻辑

我们可以使用上面创建的program对象来创建子命令，并为子命令设置回调函数。回调函数是我们执行命令时要执行的实际逻辑。

比如，我们可以为我们的CLI工具创建一个子命令，用于输出一段欢迎信息，代码如下：

program
  .command('hello')
  .description('Say hello')
  .action(() => {
    console.log(chalk.green('Hello, welcome to use this CLI tool!'));
  });

这个命令可以使用以下命令运行：

./cli.js hello

安装脚本为全局命令

我们可以使用npm提供的link命令，将我们的CLI工具安装为全局命令。全局命令可以在任何地方直接使用，而不必通过文件路径去执行它们。

在命令行中，进入到CLI工具的目录，执行以下命令：

npm link

这个命令会将我们的CLI工具链接到全局路径下，安装为全局命令。

运行CLI工具

全局安装成功后，我们就可以在任何位置直接使用我们的CLI工具了。

比如，我们可以在命令行中输入以下命令试试：

cli-tool hello

这条命令会输出以下信息：

Hello, welcome to use this CLI tool!

至此，我们完成了一个简单的CLI工具的开发。

示例一

在上面的基础上，我们可以继续完善自己的CLI工具。

比如，我们可以为它添加一个新的子命令，用于创建一个新的文件。

先在cli.js文件末尾添加以下代码：

const fs = require('fs');

program
  .command('create <filename>')
  .description('Create a new file')
  .action((filename) => {
    console.log(chalk.yellow(`Create the file: ${filename}`));
    fs.writeFileSync(filename, '');
    console.log(chalk.green(`File ${filename} created!`));
  });

这个命令可以用以下命令运行：

cli-tool create test.txt

这个命令会创建一个名为test.txt的空文件。

示例二

我们也可以为我们的CLI工具添加一些参数，让它有更多的可定制性。

比如，我们可以为create子命令添加一个可选参数--type，用于指定文件类型。代码如下：

program
  .command('create <filename>')
  .description('Create a new file')
  .option('-t, --type <type>', 'Set the file type')
  .action((filename, options) => {
    console.log(chalk.yellow(`Create the file: ${filename}`));
    let content = '';
    if (options.type === 'text') {
      content = 'Hello, world!';
    } else if (options.type === 'json') {
      content = '{}';
    } else if (options.type === 'javascript') {
      content = 'console.log("Hello, world!");';
    } else {
      content = '';
    }
    fs.writeFileSync(filename, content);
    console.log(chalk.green(`File ${filename} created!`));
  });

这里我们在create子命令中使用了option方法，添加了一个参数--type。我们为这个参数设置了一个值text，当我们执行以下命令时，就会创建一个.txt文件，并且文件中会写入“Hello, world!”：

cli-tool create test.txt --type text

除了text，我们还可以使用命令行参数创建一个.json或.js文件。

总结

CLI工具的开发使用有时还需要一些附加的包和配置，不过本文已经介绍了CLI工具开发的基本流程和步骤，以及两个示例来补充实现方式和重点信息，要开发CLI工具，关注以下几个步骤：

• 使用npm包管理器创建并配置package.json文件
• 使用commander和chalk包来编写CLI工具
• npm安装全局命令并将实际命令定到文件
• 在程序中解析命令，并使用调用操作

祝你开发CLI工具愉快