本工具用一条命令创建基于 Vite + Vue 3 的 uni-app 项目。模板、插件、模块、组件库与原子化 CSS 都可以在创建时选择。
快速开始
交互式创建
不带项目名执行时,脚手架依次询问项目名、模板与各项配置。
npm create uni@latest命令行创建
配置项全部通过参数传入时,不再进入交互提问。
npm create uni <项目名称> --ts -m pinia -m uniUse -u ano -c unocss -e图形界面
用桌面窗口代替终端提问,适合不想记参数的时候。
npm create uni --gui详见 图形化界面。
检查项目环境
npx @create-uni/info@latest
必须在 uni-app 项目根目录下执行。其他目录下会提示未检测到 @dcloudio/uni-app,无法收集依赖信息。也可以用 create-uni --info 调用同一份逻辑。
详见 环境信息。
命令行参数
| 配置项 | 参数 | 别名 | 可选值 |
|---|---|---|---|
| 模板 | --templateType | -t | 见模板 |
| TypeScript | --needsTypeScript | --ts | —— |
| 插件 | --pluginList | -p | 见插件 |
| 模块 | --moduleList | -m | 见模块 |
| UI 组件库 | --UIName | --ui、-u | 见组件库 |
| 原子化 CSS | --cssType | --css、-c | 见原子化 CSS |
| ESLint | --needsEslint | --eslint、-e | —— |
| 图形界面 | --gui | -g | —— |
| 项目环境信息 | --info | -i | —— |
| 覆盖同名目录 | --force | -f | —— |
| 帮助 | --help | -h | —— |
-p、-m、-u 可以重复传多个值。--force 遇到同名目录时直接覆盖,不再询问。
模板
| 模板名 | 描述 | 参数名 |
|---|---|---|
| vitesse-uni-app | 由 Uni Helper 维护的快速启动模板 | vitesse |
| wot | 由 Wot UI 提供的基于 vitesse-uni-app 的快速启动模板 | wot |
| wot-starter | 集成 wot-ui v1 | wot-starter |
| wot-starter-v2 | 集成 @wot-ui/ui@2 | wot-starter-v2 |
| wot-starter-retail | 基于 Wot UI 的 uni-app 零售行业模板 | wot-starter-retail |
| uView Pro | 由 uView Pro 提供的快速开发模板 | uview-pro |
| uView-Pro-Starter | 基于 vitesse-uni-app 的快速启动模板 | uview-pro-starter |
| uView-Pro-Demo | 完整组件演示模板 | uview-pro-demo |
| unisave | 适配 App、小程序、Web 三个平台 | unisave |
| tmui 3.2 | 优质 Vue3 TS Pinia Vite 跨端组件库模板 | tmui32 |
| hy-starter | 由 Hy-App UI 提供的快速启动模板 | hy-starter |
插件
| 插件名 | 描述 | 参数名 |
|---|---|---|
| vite-plugin-uni-components | 按需自动引入组件 | import |
| unplugin-auto-import | 按需自动引入 API | autoImport |
| vite-plugin-uni-pages | 提供基于文件系统的路由 | pages |
| vite-plugin-uni-layouts | 提供类 nuxt 的 layouts 系统 | layouts |
| vite-plugin-uni-manifest | 自动生成 manifest.json | manifest |
| vite-plugin-uni-platform | 按文件名分流的平台编译插件 | filePlatform |
| uni-ku-root | 模拟虚拟根组件,支持 SFC 的 App.vue | root |
| vite-plugin-component-placeholder | 占位组件的原生实现 | componentPlaceholder |
模块
| 模块名 | 描述 | 参数名 |
|---|---|---|
| pinia | 符合直觉的 Vue.js 状态管理库 | pinia |
| vitest | 基于 Vite 的测试框架 | vitest |
| uni-network | 为 uni-app 打造的基于 Promise 的网络请求库 | uniNetwork |
| uni-use | uni-app 组合式工具集 | uniUse |
| uni-promises | uni-app promise 化的 API | uniPromises |
| uni-echarts | 适用于 uni-app 的 Apache ECharts 组件 | uniEcharts |
| z-paging | 高性能、全平台兼容的分页组件 | zPaging |
| uni-highlight | 基于 sugar-high 的轻量级代码高亮组件 | uniHighlight |
组件库
| 组件库 | 描述 | 参数名 |
|---|---|---|
| uni-ui | UniApp 官方组件库 | uni |
| wot-design-uni | 高颜值、轻量化的 uni-app 组件库 | wot |
| wot-ui | 轻量、美观、AI 友好的 uni-app 组件库 | wot2 |
| TDesign | TDesign 组件库 uni-app 版 | tdesign |
| uView Pro | 全面支持 Vue 3、TypeScript 的 uni-app 生态框架 | uview-pro |
| nutui-uniapp | 京东风格的轻量级移动端组件库 | nut |
| uv-ui | 多平台快速开发的 UI 框架 | uv |
| ano-ui | 轻量级、漂亮、快速的 UnoCSS 组件库 | ano |
| hy-app | 基于 Vue 3 + TS 的 uni-app 组件库,内置 i18n 与 SCSS 全局变量 | hy-app |
不传 --UIName 时不安装组件库。
原子化 CSS
unocss 与 tailwindcss 互斥,只能选一个,也可以都不使用。
| 名称 | 描述 | 参数名 |
|---|---|---|
| unocss | 即时按需的原子级 CSS 引擎 | unocss |
| tailwindcss | 通过 weapp-tailwindcss 适配小程序的原子化 CSS 框架 | tailwindcss |
不传 --cssType 时不使用原子化 CSS。
MCP
本仓库提供 MCP 服务,让 AI 助手直接创建项目。详见 MCP 服务。
包
| 包 | 说明 |
|---|---|
| create-uni | 脚手架本体,npm create uni 执行的就是它 |
| @create-uni/info | 检测 uni-app 项目的依赖、环境与 VS Code 插件情况 |
| @create-uni/gui | --gui 打开的桌面窗口,用 Rust + WebView 实现 |
| @create-uni/mcp | 给 AI 助手用的 MCP 服务,暴露两个创建项目的工具 |
packages/config、packages/shared、packages/ui 是上面几个包共用的内部包,不单独发布。
开发
- Node.js 24 及以上。仓库未固定具体版本。
- pnpm 12.3.4,见根
package.json的packageManager。 - Rust stable,仅
packages/gui需要。仓库未固定版本,按当前依赖解析结果需要 1.89 及以上。
pnpm i # 安装依赖,postinstall 会把 create-uni、@create-uni/info、@create-uni/gui link 到根目录
pnpm build:core # 构建 CLI 到 packages/core/dist/outfile.cjs
pnpm play # 用刚构建的产物跑一次,等价于 pnpm create-uni
参与贡献
可以提交新功能,反馈或解决 issues,也可以提交新的模板、插件、模块或组件库。
动手之前必须读一遍 CONTRIBUTING.md。
致谢
项目灵感与部分代码来自 create-vue。