@ysjdemo/umi-create-cli
Version:
一个用于创建Umi4项目的脚手架工具
94 lines (69 loc) • 1.92 kB
Markdown
# @ysjdemo/umi-create-cli
一个用于创建Umi4项目的脚手架工具
## 使用方式(推荐npx)
```bash
# 🔥 推荐:使用 npx 直接创建(无需安装)
# 会自动提示选择模板,默认推荐 Ant Design Pro
npx @ysjdemo/umi-create-cli create my-project
# 或直接指定模板
npx @ysjdemo/umi-create-cli create my-project -t antd
npx @ysjdemo/umi-create-cli create my-project -t basic
# 查看帮助
npx @ysjdemo/umi-create-cli --help
```
## 交互式模板选择
当您运行创建命令时,会看到如下交互界面:
```
🚀 创建 Umi4 项目...
📋 请选择项目模板:
❯ 🎨 antd - Ant Design Pro 模板 (推荐)
📦 basic - 基础模板
```
## 安装方式(可选)
如果需要频繁使用,可以选择全局安装:
```bash
# 全局安装
npm install -g @ysjdemo/umi-create-cli
# 或使用 yarn
yarn global add @ysjdemo/umi-create-cli
# 安装后使用
ysj-umi create my-project
ysj-umi --version
```
## 特性
- 🚀 快速创建Umi4项目
- 📦 内置常用配置模板
- 🎨 支持TypeScript
- 📱 支持多种UI库选择
- ⚡️ 支持npx直接使用,无需安装
- 🎯 交互式模板选择,默认推荐最佳实践
## 模板选项
- **🎨 Ant Design Pro 模板**(推荐):企业级后台管理系统
```bash
npx @ysjdemo/umi-create-cli create my-admin -t antd
```
- 集成 Ant Design 5.0
- Pro Components 组件库
- 完整的后台管理界面
- 仪表盘、用户管理、设置页面
- **📦 基础模板**:轻量级起始项目
```bash
npx @ysjdemo/umi-create-cli create my-project -t basic
```
- 基础 Umi 4 配置
- TypeScript 支持
- 简洁的项目结构
## 开发
```bash
# 克隆项目
git clone https://github.com/Ivan-YangSj/umi-cli.git
# 安装依赖
npm install
# 本地开发测试
npm start
# 发布新版本
npm version patch
git push origin --tags
```
## License
MIT