create-umix
v0.1.0
Published
Create a Umi Max + Ant Design Pro enterprise project with one command
Downloads
105
Maintainers
Readme
create-umix
企业级 Umi Max + Ant Design Pro 项目脚手架,一条命令快速创建开箱即用的中后台项目。
快速开始
无需安装,直接使用包管理器执行:
# pnpm(推荐)
pnpm create umix
# npm
npm create umix@latest
# yarn
yarn create umix
# bun
bun create umix也可以直接指定项目名称,跳过第一个交互步骤:
pnpm create umix my-app交互流程
运行后会依次提示:
| 步骤 | 说明 |
|------|------|
| 项目名称 | 同时作为目录名,不能与已有目录重名 |
| 项目描述 | 可选,写入 package.json 的 description |
| 作者 | 可选,写入 package.json 的 author |
| 选择模板 | 目前提供 Default 模板(Umi Max + Ant Design Pro) |
| 包管理器 | 支持 pnpm / npm / yarn / bun,自动检测当前环境 |
| 安装依赖 | 选择是否在创建后立即安装依赖 |
完成后按提示进入目录并启动开发服务器即可。
可用模板
| 名称 | 说明 | |------|------| | Default | Umi Max + Ant Design Pro,开箱即用企业级模板 |
环境要求
- Node.js
>= 18
本地开发
# 克隆仓库
git clone https://github.com/zzj0231/create-umix.git
cd create-umix
# 安装依赖
pnpm install
# 监听模式构建
pnpm dev
# 生产构建
pnpm build
# 本地测试
node dist/index.js my-test-app新增模板
在 src/templates.ts 的 templates 数组中追加一项即可,CLI 会自动将其展示在选项中:
{
name: 'mobile',
display: 'Mobile',
repo: 'your-github-username/your-template-repo',
branch: 'main',
description: '移动端适配版本',
}
repo字段格式为owner/repo,脚手架内部使用 giget 从 GitHub 拉取。
技术栈
- @clack/prompts — 交互式命令行 UI
- giget — 从 GitHub 拉取模板
- kolorist — 终端颜色输出
- execa — 执行子进程(安装依赖)
- tsup — TypeScript 构建
