ViteKit CLI使用方法
本页面详细介绍了 ViteKit CLI 的各种使用方法和高级功能。
基本用法
创建新项目
最简单的用法是创建一个新项目：
bash
vitekit my-project
这将创建一个名为 my-project 的目录，并使用默认模板初始化项目。
在当前目录创建项目
如果您想在当前目录创建项目：
bash
vitekit .
命令行选项
查看帮助
bash
vitekit --help
# 或
vitekit -h
查看版本
bash
vitekit --version
# 或
vitekit -V
指定模板
bash
vitekit my-project --template vue
# 或
vitekit my-project -t vue
可用模板
ViteKit CLI 提供多种项目模板：
Vue 3 模板
bash
vitekit my-project --template vue
特性：
- Vue 3 + TypeScript
- Vue Router 4
- Pinia 状态管理
- Vite 构建工具
- ESLint + Prettier
- Vitest 测试框架
React 模板
bash
vitekit my-project --template react
特性：
- React 18 + TypeScript
- React Router 6
- Zustand 状态管理
- Vite 构建工具
- ESLint + Prettier
- Vitest 测试框架
Vanilla 模板
bash
vitekit my-project --template vanilla
特性：
- 纯 TypeScript
- Vite 构建工具
- ESLint + Prettier
- 最小化配置
交互式创建
如果不指定模板，ViteKit CLI 会启动交互式创建流程：
bash
vitekit my-project
您将看到以下提示：
? 请选择项目模板:
❯ Vue 3 + TypeScript
React + TypeScript
Vanilla TypeScript
? 是否需要路由? (Y/n)
? 是否需要状态管理? (Y/n)
? 是否需要测试框架? (Y/n)
项目初始化后的操作
进入项目目录
bash
cd my-project
安装依赖
bash
npm install
# 或
yarn install
# 或
pnpm install
启动开发服务器
bash
npm run dev
构建生产版本
bash
npm run build
预览生产版本
bash
npm run preview
高级用法
使用自定义模板
您可以使用 GitHub 仓库作为模板：
bash
vitekit my-project --template github:username/repo-name
使用本地模板
bash
vitekit my-project --template file:../my-template
跳过 Git 初始化
bash
vitekit my-project --no-git
跳过依赖安装
bash
vitekit my-project --no-install
强制覆盖现有目录
bash
vitekit my-project --force
环境变量
您可以通过环境变量配置 ViteKit CLI 的行为：
VITEKIT_REGISTRY
指定 npm 注册表：
bash
VITEKIT_REGISTRY=https://registry.npmmirror.com vitekit my-project
VITEKIT_TEMPLATE_DIR
指定自定义模板目录：
bash
VITEKIT_TEMPLATE_DIR=/path/to/templates vitekit my-project
配置文件
您可以在用户主目录创建 .vitekitrc 文件来设置默认配置：
json
{
"defaultTemplate": "vue",
"registry": "https://registry.npmmirror.com",
"skipGit": false,
"skipInstall": false
}
常见工作流程
快速原型开发
bash
# 创建项目
vitekit prototype --template vanilla
cd prototype
# 启动开发
npm run dev
团队项目开发
bash
# 使用团队模板
vitekit team-project --template github:company/team-template
cd team-project
# 安装依赖
npm install
# 运行测试
npm run test
# 启动开发
npm run dev
生产部署准备
bash
# 构建项目
npm run build
# 预览构建结果
npm run preview
# 运行生产前检查
npm run lint
npm run type-check
npm run test
故障排除
模板下载失败
如果模板下载失败，可以尝试：
- 检查网络连接
- 使用国内镜像
- 手动指定模板路径
依赖安装失败
如果依赖安装失败：
- 清除 npm 缓存：
npm cache clean --force - 删除
node_modules和package-lock.json - 重新安装：
npm install
权限问题
如果遇到权限问题，请参考 安装指南 中的故障排除部分。