在Node.js中创建一个CLI工具库并发布到npm需要以下步骤:
- 创建项目并初始化npm:
mkdir my-cli-tool
cd my-cli-tool
npm init -y
- 创建CLI工具的核心逻辑。例如,创建一个名为
index.js
的文件,并编写CLI工具的主要功能:
#!/usr/bin/env node
const program = require('commander');
program
.version('1.0.0')
.description('CLI tool to demonstrate publishing to npm');
program
.command('greet <name>')
.description('Greet someone')
.action((name) => {
console.log(`Hello, ${name}!`);
});
program.parse(process.argv);
- 安装必要的依赖,如
commander
用于CLI参数解析:
npm install commander
- 在
package.json
中配置bin
字段,指定CLI命令的入口:
{
"name": "my-cli-tool",
"version": "1.0.0",
"description": "A CLI tool example",
"main": "index.js",
"bin": {
"mycli": "./index.js"
},
"scripts": {
"start": "node index.js"
},
"dependencies": {
"commander": "^8.0.0"
}
}
- 确保脚本文件有可执行权限,并运行
npm link
创建全局链接,以便可以从任何地方调用它:
chmod +x index.js
npm link
- 发布到npm。首先确保你有一个npm账户,然后登录:
npm login
- 发布包到npm:
npm publish
完成这些步骤后,你就可以在任何项目中使用mycli
命令了。