Qiuye FE CLI

Qiuye FE CLI 是一个交互式项目脚手架，用于从预设的 GitHub 模板创建新项目。脚手架会引导你选择模板及可用版本，并将模板内容下载到本地目录。

快速开始

请先安装以下环境：

• Node.js 18 或更高版本，推荐使用当前维护中的 LTS 版本
• Git

无需全局安装，直接运行：

npx qiuye-fe-cli@latest

根据提示输入项目名称并选择模板。选择具有多个版本的模板时，脚手架还会继续询问要使用的版本。

如果希望预先指定项目名称，可以运行：

npx qiuye-fe-cli@latest create my-app

创建完成后进入项目目录，并按照所选模板自身的 README 安装依赖和启动项目：

cd my-app

如果目标目录已存在且不为空，脚手架会在覆盖前要求确认。确认覆盖会清空该目录，请先确保其中没有需要保留的文件。

命令

以下示例均通过 npx 运行，无需安装全局命令。

| 命令 | 说明 | | --- | --- | | npx qiuye-fe-cli@latest | 进入完整的交互式创建流程 | | npx qiuye-fe-cli@latest create [project-name] | 创建项目，可选预先指定项目名称 | | npx qiuye-fe-cli@latest list | 查看当前可用的模板及版本 | | npx qiuye-fe-cli@latest --help | 查看命令帮助 | | npx qiuye-fe-cli@latest --version | 查看 CLI 版本 |

可用模板

| 模板 | 状态 | 说明 | | --- | --- | --- | | Qiuye Next.js Template | 推荐 | 基于 Next.js 15 的 React 应用模板 | | Qiuye Electron Template | 可用 | 基于 React、Vite 和 Electron 的桌面应用模板 | | Skill Installer Template | 可用 | 用于构建交互式 AI Skill 安装器 | | Qiuye React Template（精简版） | 已弃用 | 早期 React 基础模板，仅用于兼容已有项目 | | Qiuye React Template（扩展版） | 已弃用 | 带有路由守卫和登录页的早期 React 模板，仅用于兼容已有项目 |

Electron 模板版本

选择 Electron 模板后，可以继续选择运行时版本：

| 版本 | 模板分支 | 适用场景 | | --- | --- | --- | | 现代版，Electron 41 | electron-modern | 默认推荐。使用 Chromium 146 和内置 Node.js 24，支持 CSS 平滑圆角等较新的 Chromium 特性；模板开发环境支持 Node.js 22 或 24 | | 兼容版，Electron 33 | main | 保留旧版运行时，适合仍需兼容既有环境的项目；模板开发环境推荐 Node.js 20 |

CLI 本身的 Node.js 版本要求与各模板的开发环境要求并不相同。项目创建完成后，请以所选模板 README 中的环境说明为准。

工作方式

脚手架使用 degit 从模板仓库的指定分支下载文件，因此生成的目录不包含模板仓库的 Git 历史。下载过程需要能够访问 GitHub。

项目名称只能包含字母、数字、连字符和下划线，并且必须以字母开头。

本地开发

仓库使用 pnpm lockfile。为避免不同 pnpm 版本改写 lockfile，建议使用 pnpm 8.7.0：

git clone https://github.com/QiuYeDx/qiuye-fe-cli.git
cd qiuye-fe-cli
corepack [email protected] install
corepack [email protected] test

直接运行本地源码进行交互测试：

node bin/index.js

模板定义位于 lib/templates.js，具有多个版本的模板通过 variants 配置对应分支。修改模板配置后，应运行测试确认版本解析结果正确。

License

MIT