@kohinata/cli
v1.0.2
Published
CLI entry point for Plume projects
Readme
@kohinata/cli
Plume CLI 入口包,提供命令行工具支持。
安装
# 全局安装
pnpm add -g @kohinata/cli
# 或者在项目中安装
pnpm add @kohinata/core
pnpm add -g @kohinata/cli使用
前置条件
- Node.js >= 18.18.0
- 项目目录必须包含
package.json - 项目必须安装
@kohinata/core依赖
命令
plume init # 初始化项目配置
plume app # 前台启动项目
plume start # 前台启动项目
plume pm2 # PM2 后台运行
plume stop # 停止后台服务
plume restart # 重启后台服务
plume log # 查看日志
plume up # 更新依赖
plume b <action> # 构建依赖管理开发模式
在 Plume monorepo 根目录下,CLI 会自动检测开发模式:
# 方式1: 直接运行 CLI 入口
node packages/cli/src/index.js <command>
# 方式2: 运行 core 中的 CLI 实现
node packages/core/dist/cli/index.js <command>
# 方式3: 使用 pnpm 脚本
pnpm cli <command>架构说明
本包采用 KarinJS 架构模式:
@kohinata/cli: 轻量级入口包,检查项目环境并调用@kohinata/core中的 CLI 实现@kohinata/core: 核心框架包,包含 CLI 核心实现
这种设计的优势:
- 入口包体积小,安装快速
- CLI 实现与核心框架紧密集成
- 用户只需安装
@kohinata/core即可获得完整功能
错误排查
| 错误信息 | 原因 | 解决方案 |
|---------|------|---------|
| 请在 Plume 项目目录下运行此命令 | 当前目录没有 package.json | 切换到项目根目录 |
| 请先安装 @kohinata/core 依赖 | 项目未安装 @kohinata/core | 运行 pnpm add @kohinata/core |
| CLI 文件不存在 | 构建产物不存在 | 运行 pnpm build |
| 开发模式下 CLI 文件不存在 | monorepo 未构建 | 运行 pnpm build |
License
MIT
