@kohinata/create-plume

Plume 官方中文脚手架，用于快速创建机器人框架项目和插件模板。

特性

• 支持 Plume Project、TypeScript 插件、JavaScript 插件
• 支持交互式创建，也支持 -y 快速创建
• 支持指定 @kohinata/core 版本和 npm 镜像源
• 生成项目时默认不手动创建配置文件

使用

pnpm create plume

指定目录：

pnpm create plume my-bot

指定模板：

pnpm create plume my-plugin --template plugin-ts

快速创建：

pnpm create plume my-bot -y

模板说明

Plume Project

标准机器人框架项目，包含：

• src/index.ts 入口文件
• src/apps/example.ts 示例命令
• data/ 数据目录
• resources/ 资源目录
• tsup 构建配置
• PM2 启动示例

TypeScript 插件

适合开发可构建、可发布的插件，包含：

• src/index.ts
• src/apps/example.ts
• tsconfig.json
• tsup.config.ts

JavaScript 插件

适合零编译轻量开发，包含：

• src/index.js
• src/apps/example.js

命令行参数

@kohinata/create-plume [目录] [选项]

可用选项：

• -h, --help：显示帮助信息
• -y, --yes：使用默认配置快速创建
• --template <name>：指定模板，支持 project、plugin-ts、plugin-js
• --version <version>：指定 @kohinata/core 版本

生成后的常用命令

机器人项目：

pnpm install
pnpm run app

插件项目：

pnpm install
pnpm run dev

环境要求

• Node.js >= 18.18.0

License

MIT