SuperAPI AI 工具集

cli-builder

编程与开发

查看项目

更新于 10-16 08:45

技能介绍

用途:这是一份使用 Bun 构建 TypeScript 命令行工具(CLI)的实践指南,适合创建开发者工具、自动化脚本、项目专属命令,以及能与 shell 管道组合的工具。

主要能力:介绍最小 CLI 结构与 #!/usr/bin/env bun;使用 Node 的 parseArgs(在 Bun 中可用)解析参数与选项;通过命令注册表实现子命令模式并生成帮助信息;无依赖终端配色输出;支持 --json 可脚本化输出;用 setInterval 实现简易 spinner 进度提示;基于 fs/promises、fs、path 做文件读写与目录创建;用 Bun 的 $ 执行 shell 命令并捕获输出或处理错误;通过 CLIError 统一错误与退出码;以及用 package.json 的 bin 字段、bun build 打包和 chmod +x 分发。

使用方式:脚本首行写 #!/usr/bin/env bun,用 bun scripts/my-tool.ts hello 直接运行;参数解析调用 parseArgs({ args, options, allowPositionals }),子命令从 argv 取第一个位置参数再分发;分发时在 package.json 配置 bin,并用 bun build 生成产物。

适用场景:开发者工具、项目脚本、需要参数与标志的自动化任务、与 shell 管道协作的工具。

最佳实践与限制:始终提供 --help;成功退出码为 0、错误为非零;支持 --json 便于管道;尽早校验输入快速失败;默认安静、用 --verbose 输出细节;尊重 NO_COLOR;大输出应流式处理而非全部缓冲。资料未提供该项目的版本、收费、平台支持范围与性能数据。