# cubes-cli

**Repository Path**: wallesoft/cubes-cli

## Basic Information

- **Project Name**: cubes-cli
- **Description**: No description available
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-09
- **Last Updated**: 2026-10-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cubes-cli

Cubes 框架命令行工具，提供项目创建、代码生成、插件开发、环境诊断等功能。

## 功能

- **new** - 创建新的 Cubes 应用项目
- **dev** - 启动主程序开发环境（支持 Air 热重载、前端开发服务器、Wails 绑定自动生成）
- **build** - 主程序生产构建（环境检查 → 清理 → 生成绑定 → 前端构建 → 后端打包）
- **plugin init** - 初始化新插件项目（交互式向导或命令行参数，SDK 已内嵌，可选 Git 初始化；`--with-ws` 一键生成 WebSocket 绑定通道，前端直调 Go 方法开箱即用）
- **plugin build** - 构建插件（前端 + 后端），支持开发/生产模式
- **plugin dev** - 一键启动插件开发环境（构建插件 + 启动主程序）
- **plugin generate** - 扫描插件绑定注册，生成类型化 TypeScript 前端客户端（对标 Wails 绑定，plugin dev / Air 重建自动刷新）
- **plugin install/uninstall/list** - 插件管理
- **plugin validate** - 验证插件结构和配置
- **plugin package-sdk** - 打包插件开发 SDK（SDK + 文档 + 示例插件，供第三方分发）
- **generate** - 快速生成规范化代码（model / service / frontend / full 一键 CRUD，支持事件钩子、校验、测试骨架、自动注册）
- **doctor** - 诊断开发环境（含 PATH 自动注册）
- **list** - 列出可用模板

## 安装

```bash
go install gitee.com/wallesoft/cubes-cli@latest
// 国内注意设置代理
go env -w GOPROXY=https://goproxy.cn,direct

```

安装后运行 `cubes-cli doctor` 检查环境，如未注册到 PATH 会自动提示。

## 快速开始

### 创建主应用

```bash
# 创建项目（含交互式配置向导）
cubes-cli new --name my-app

# 进入项目
cd my-app
go mod tidy
cd frontend && npm install && cd ..

# 启动开发环境
cubes-cli dev --air

# 完整开发体验（后端热重载 + 前端热重载 + Wails 绑定自动生成）
cubes-cli dev --air --frontend --bindings

# 生产构建（环境检查 → 清理 → 生成绑定 → 前端构建 → 后端打包）
cubes-cli build
```

### 开发插件

```bash
# 交互式创建插件
cubes-cli plugin init

# 或指定参数直接创建
cubes-cli plugin init --id my-plugin --name "My Plugin" --version 1.0.0

# 构建插件
cubes-cli plugin build --dir ./plugins/my-plugin

# 验证插件结构
cubes-cli plugin validate --dir ./plugins/my-plugin

# 启动插件开发环境（构建插件 + 启动主程序加载插件）
cubes-cli plugin dev --dir ./plugins/my-plugin --main ../../main.go --air

# 打包插件 SDK 供第三方分发（含文档与示例插件）
cubes-cli plugin package-sdk --docs doc/插件 --example plugins/demo-plugin
```

### 生成代码

```bash
# 一键生成完整 CRUD（模型 + 三层 + 事件常量 + 测试 + 自动注册 + 前端页面）
cubes-cli generate full --name=part --comment=零件 --fields="name:string!,price:float,stock:int"

# 也可以分步生成
cubes-cli generate model --name=part --fields="name:string!,price:float"
cubes-cli generate service --name=part --comment=零件 --events --validate --tests
cubes-cli generate frontend --name=part --comment=零件
```

## 生成的插件结构

```
plugins/my-plugin/
├── main.go              # Go 后端主文件
├── frontend_dev.go      # 开发模式前端服务器
├── frontend_prod.go     # 生产模式前端嵌入
├── plugin.json          # 插件配置
├── go.mod               # Go 模块
├── plugin-sdk/          # 插件 SDK (IPC 通信)
│   ├── go.mod
│   └── ipc.go
├── frontend/            # Vue 前端
│   ├── package.json
│   ├── vite.config.js
│   ├── index.html
│   └── src/
│       ├── main.js
│       └── App.vue
├── build-plugin-full.bat
└── dev-build.bat
```

## 命令总览

| 命令 | 别名 | 说明 |
|------|------|------|
| `doctor` | `doc` | 诊断开发环境（含版本信息、PATH 检查） |
| `self-upgrade` | `upgrade` | 升级 cubes-cli 到最新版本 |
| `new` | `create` | 创建新的 Cubes 应用项目 |
| `dev` | `d` | 启动主程序开发环境（Air 热重载 / 前端 / Wails 绑定） |
| `build` | `b` | 主程序生产构建（绑定 + 前端 + 后端） |
| `generate` | `g` | 快速生成规范化代码（model / service / frontend / full） |
| `plugin init` | `plugin i` | 初始化插件项目（SDK 已内嵌，`--with-ws` 生成绑定通道） |
| `plugin build` | `plugin b` | 构建插件（前端 + 后端） |
| `plugin validate` | `plugin check` | 验证插件结构和配置 |
| `plugin dev` | `plugin d` | 启动插件开发环境 |
| `plugin generate` | `plugin gen` | 生成插件绑定 TypeScript 客户端（AST 扫描 + 类型映射） |
| `plugin install` | — | 安装插件 |
| `plugin uninstall` | `plugin u` | 卸载插件 |
| `plugin list` | — | 列出已安装插件 |
| `plugin package-sdk` | — | 打包插件开发 SDK（供第三方分发） |
| `list` | `ls` | 列出可用模板和命令 |

## 许可证

非商业使用：免费（详见 [LICENSE](LICENSE)）

商业用途需书面授权，请联系 x@walle.online