轻量CLI命令工具
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_f1b049da/bkj2026355 到 AI 助手中。
技能介绍
把一次性脚本变成顺手命令当你在一个多个 Node 工具的仓库里工作,经常会遇到两类脚本需求:一是给团队用的本地命令,比如导出客户列表、清理构建产物、批量重命名文件;二是内部工具箱的入口,让其他成员通过 node cli.mjs --help 就能知道怎么用。这类脚本如果每次都从零手写,很快会碰到几个痛点:
- 参数解析反复造轮子:直接拆
process.argv,遇到-c branch main和--force时要自己处理长短参数、默认值和布尔开关,代码越写越臃肿; - 帮助文本缺失或不统一:用户忘了参数含义时,只能靠注释或口头说明,
--help要么不存在要么格式随意; - 脚本入口难复用:早期脚本没有导出
defineCommand和runMain,复制到另一个项目时往往要重写一遍。
这个技能如何组织命令这个技能提供了一套基于 citty 的轻量约定,核心是 defineCommand → args → runMain 三步结构。安装依赖后,先写一个 bin 入口文件,例如 cli.mjs,在里面通过 runMain 启动主命令;命令主体用 defineCommand 定义,其中通过 args 声明参数的类型、默认值和描述。一个完整的命令定义大致是这样:
import { defineCommand, runMain } from 'citty';
export const mainCommand = defineCommand({
args: {
token: { type: 'string', required: true, description: 'API token' },
force: { type: 'boolean', default: false },
},
async run({ args }) {
// 参数已被解析并类型化,直接使用 args.token 和 args.force
},
});
if (import.meta.url === `file://${process.argv[1]}`) {
runMain(mainCommand);
}
这样就能得到自动生成的帮助:运行脚本时,--help 会打印所有参数的描述和用法。传入参数时,命令内部拿到的是已经解析的对象,不再需要再手动处理 process.argv。随后用 node cli.mjs --token a1b2 --force 传入参数即可。对于常见的导出场景,比如导出客户列表,你可以将导出逻辑写成 run 部分,并在 args 里声明 --limit、--format 等选项,完事后把脚本丢进 bin/ 目录,其他成员只要安装依赖就能用。
适用范围与注意事项
这套方案聚焦在带参数的小命令上,适合作为仓库内部工具箱的统一入口,或者项目中独立脚本的快速启动。它有明确的硬约束:
- 依赖 Node 环境下的
citty库,暂不覆盖其他运行时; - 参数必须用
args的类型定义声明,明确输入规则; - 实现要点标注为小四原创,不涉及完整 monorepo 脚手架,也不处理打包、发布或远程安装;
实践时建议先跑一次 node cli.mjs --help 确认帮助输出,再按实际脚本功能验证参数行为。适用场景之外的复杂需求(例如多级子命令、插件化扩展)最好寻求更重型的 CLI 框架,避免在这层小封装里强行堆功能。
使用场景
- 在多人协作的小型 Node 脚本仓库中,需要统一各脚本的导出保存逻辑
- 开发者需要为一批批处理脚本提供统一的清理构建文件残留的子任务
- 团队在整理客户反馈列表时需要一个命令来将数据导出为CSV或直接清空
- 当一个协作脚本缺少说明时,可以利用该方法快速生成标准帮助文本。
适合人员
- 寻求轻量级Node命令提示工具的中央工具箱开发者
- 需要在Node框架中频繁创建简单命令的前端开发
- 正在构建项目早期CLI功能的工程团队成员
- 负责维护简单自动化脚本的执行基础的工程师