@lcap-delivery/razel-cli
v0.0.4
Published
Razel CLI
Downloads
414
Readme
razel-cli
TypeScript + Yargs 的命令行工具,采用插件式子命令;安装后对外命令为 razel-cli。
- 要求:Node.js ≥ 18
- 开发:
npm install→npm run dev -- <子命令>;npm run build产出dist/
子命令
| 命令 | 说明 |
|------|------|
| init | 初始化 ~/.razel/config.json |
| config | 管理 ~/.razel/config.json(点路径) |
| popo | POPO 平台能力(含 popo doc) |
| tencent-meeting | 腾讯会议回放嗅探 / 下载 |
各命令的参数、行为与示例见对应目录下的 README.md。
新增一个子命令
- 新建目录
src/commands/<命令名>/(可含index.ts、实现文件、可选的README.md)。 - 实现注册函数:导出
(yargs: Argv) => Argv,类型为CommandPlugin。在函数内调用yargs.command(...)挂载顶层命令名与子命令(写法可参考src/commands/tencent-meeting/index.ts)。 - 挂到入口:在
src/commands/index.ts的commandPlugins数组中追加你的registerXxxCommand(勿忘.js扩展的 import,与现有 ESM 约定一致)。 - 文档:在本节上表增加一行,并在
src/commands/<命令名>/README.md中写明用法(可选但推荐)。 - 验证:
npm run dev -- <命令名> --help、npm run typecheck、npm run build。
若新命令需要新的 npm 运行时依赖,在 package.json 的 dependencies 中添加;被 tsup external 的包需在 tsup.config.ts 中声明。
