从零开始：用Node.js和TypeScript创建CLI命令行工具

2023-10-21 11:16:56

背景：CLI命令行工具的由来与应用
随着软件开发的日新月异，各种开发工具层出不穷，而CLI命令行工具凭借其简单易用、高效便捷的特点，在开发人员中广受欢迎。CLI工具可以通过命令行界面与用户交互，执行各种任务和操作，例如文件管理、代码编译、项目构建等。

从零开始：用Node.js + TypeScript创建CLI命令行工具

创建项目

mkdir my-cli-tool
cd my-cli-tool
npm init -y

初始化

npm install typescript -D
npx tsc --init

得到package.json内容如下

{
  "name": "my-cli-tool",
  "version": "1.0.0",
  "description": "A CLI tool created with Node.js and TypeScript.",
  "main": "index.ts",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "ts-node index.ts"
  },
  "keywords": [
    "nodejs",
    "typescript",
    "cli",
    "command-line-tool"
  ],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "typescript": "^4.9.3"
  },
  "devDependencies": {
    "ts-node": "^10.9.1"
  }
}

安装一些依赖

npm install commander

生成Typescript的配

// index.ts
import { program } from 'commander';

program
  .name('my-cli-tool')
  .description('A CLI tool created with Node.js and TypeScript.')
  .version('1.0.0')
  .action(() => {
    console.log('Hello, world!');
  })
  .parse(process.argv);