演示

CLI

从 npm 安装 @quan-erp/cli，用于脚手架项目/插件、watch 构建、生产打包，以及启动本地 base Docker 栈。请在 Quark ERP 项目根目录运行（new-project 可用空目录）。

安装

官方 CLI 发布在 npm 的 @quan-erp/cli。需要 Node.js 18+。安装后以 quan-erp 为主命令（quark-erp / erp 为别名）。

  • npm i -g @quan-erp/cli — 全局安装
  • quan-erp — 主命令
  • quark-erp / erp — 别名
SHinstall
npm i -g @quan-erp/cli
@quan-erp/cli on npm →

命令

new / new-plugin / new-project 可选用 --version <tag>（默认 latest）指定模板版本。

命令说明
quan-erp version / -v / --version打印 CLI 版本
quan-erp new / new-plugin脚手架插件
quan-erp new-project克隆项目模板
quan-erp watch <plugin>开发时监视并重建
quan-erp build:prod <plugin>生产构建 → available-plugins/
quan-erp pack:prod <plugin>生产构建 + zip
quan-erp base:dev启动 base Docker 栈
quan-erp help显示用法
TShelp
quan-erp help

new-project

将官方模板脚手架到当前目录（建议使用空文件夹）。

TSnew-project
quan-erp new-project quan-erp new-project --version latest

new / new-plugin

在 plugins/ 下交互式脚手架插件。

TSnew plugin
quan-erp new quan-erp new-plugin quan-erp new-plugin --version latest

watch

日常主命令。在开发中重建插件并同步到 base/available-plugins/<name>/<version>/。

  • 参数：plugins/ 下的文件夹名（须与 module.metadata.json 的 name 一致）
  • 在项目根目录运行
TSwatch
quan-erp watch sample-es

build:prod 与 pack:prod

build:prod — 生产编译到 available-plugins。pack:prod — 需要 zip 分发时使用。

TSbuild & pack
quan-erp build:prod sample-es quan-erp pack:prod sample-es

base:dev

从项目根目录启动本地 base Docker 栈。

TSbase:dev
quan-erp base:dev # equivalent: docker compose -f base/docker-compose.yaml up -d

输出目录

watch / 生产构建将带版本产物放在 available-plugins。从 ERP UI 安装后进入 installed-plugins。

SHpaths
1base/available-plugins/<plugin-name>/<version>/ 2├── backend/ 3├── frontend/ 4└── module.metadata.json 5 6base/backend/installed-plugins/<plugin-name>/ 7├── backend/ 8├── frontend/ 9└── module.metadata.json

提示

  • 优先使用 npm 上的 @quan-erp/cli，而不是旧的仓库根目录 ./erp
  • 在项目根目录运行 — 需要相对路径 plugins/ 与 base/
  • module.metadata.json 中的 pluginVersion 对应 available-plugins 的版本目录
  • 若 UI 未更新，检查 available-plugins 与 installed-plugins
  • 用 quan-erp help 查看已安装 CLI 支持的命令