cli-tool

# CLI 工具模板 ## 技术栈 | 组件 | 技术 | |-----------|------------| | 运行时 | Node.js 20+ | | 语言 | TypeScript | | CLI 框架 | Commander.js | | 提示词 | Inquirer.js | | 输出 | chalk + ora | | 配置 | cosmiconfig | --- ## 目录结构 project-name/ ├── src/ │ ├── index.ts # 入口文件 │ ├── cli.ts # CLI 设置 │ ├── commands/ # 命令处理器 │ ├── lib/ │ │ ├── config.ts # 配置加载器 │ │ └── logger.ts # 样式化输出 │ └── types/ ├── bin/ │ └── cli.js # 可执行文件 └── package.json --- ## CLI 设计原则 | 原则 | 描述 | |-----------|-------------| | 子命令 | 对相关操作进行分组 | | 选项 | 带有默认值的标志 | | 交互式 | 需要时显示提示词 | | 非交互式 | 支持 --yes 标志 | --- ## 核心组件 | 组件 | 用途 | |-----------|---------| | Commander | 命令解析 | | Inquirer | 交互式提示词 | | Chalk | 彩色输出 | | Ora | 加载动画/旋转器 | | Cosmiconfig | 配置文件发现 | --- ## 设置步骤 1. 创建项目目录 2. `npm init -y` 3. 安装依赖: `npm install commander @inquirer/prompts chalk ora cosmiconfig` 4. 在 package.json 中配置 bin 5. `npm link` 用于本地测试 --- ## 发布 bash npm login npm publish --- ## 最佳实践 - 提供有用的错误消息 - 同时支持交互式和非交互式模式 - 使用一致的输出样式 - 使用 Zod 验证输入 - 使用正确的退出代码 (0 成功, 1 错误)