分享一个通用 Nodejs cli 项目

发布于 1周前 作者 nodeper 来自 nodejs/Nestjs

分享一个通用 Nodejs cli 项目

分享一个我折腾的通用 cli 项目 (nodejs)

项目地址: https://github.com/needood/cliver

灵感来自于之前做项目需要要把一个子项目集成现成的逻辑比较容重的 cli 中.

如同主流构建工具的 cli, cli 的逻辑的分离利于 cli 的升级维护而不影响旧有项目.

项目不足自处,希望多多指点


1 回复

分享一个通用 Node.js CLI(命令行界面)项目模板,可以帮助你快速启动一个新的 CLI 工具项目。这个项目模板包括基本的文件结构、常用的依赖库以及一个示例命令。

项目结构

my-cli-tool/
├── bin/
│   └── my-cli.js
├── lib/
│   └── commands/
│       └── hello.js
├── package.json
└── README.md

初始化项目

首先,确保你已经安装了 Node.js 和 npm。然后在项目目录中运行以下命令初始化项目:

npm init -y
npm install commander yargs

示例代码

bin/my-cli.js

#!/usr/bin/env node

const { Command } = require('commander');
const hello = require('../lib/commands/hello');

const program = new Command();
program.addCommand(hello);
program.parse(process.argv);

lib/commands/hello.js

const { Command } = require('commander');

const helloCommand = new Command('hello')
  .description('say hello')
  .action(() => {
    console.log('Hello, world!');
  });

module.exports = helloCommand;

运行项目

package.json 中添加以下脚本:

"bin": "./bin/my-cli.js"

然后运行 npm link,你就可以在命令行中使用 my-cli hello 来运行这个 CLI 工具了。

这个模板提供了一个简单的起点,你可以根据需要扩展和修改。

回到顶部