快速上手
安装
5 分钟内在您的项目中完成 Virex 的设置。本指南涵盖安装、身份验证以及您的首次部署。
开始使用 Virex 只需几分钟。本指南将带您完成安装、身份验证以及部署您的第一个项目。
前置条件
在开始之前,请确保您已具备:
- 本机已安装 Node.js 18+
- 一个 Virex 账号(在 virex.example.com 注册)
- 已安装并配置好 Git
安装 CLI
Virex CLI 是与平台交互的主要方式。全局安装它:
npm install -g @virex/cli
验证安装:
virex --version
身份验证
登录您的 Virex 账号:
virex login
这会打开浏览器进行身份验证。完成后,您就可以创建项目了。
初始化项目
进入您的项目目录并初始化 Virex:
cd your-project
virex init
这会创建一个带有合理默认配置的 virex.config.js 文件:
export default {
name: 'your-project',
framework: 'auto', // Virex 自动检测您的框架
buildCommand: 'npm run build',
outputDirectory: 'dist',
};
部署
使用一条命令部署您的项目:
virex deploy
就是这样!Virex 将会:
- 构建您的项目
- 上传构建产物
- 部署到预览 URL
- 返回线上 URL
下一步
完成设置后:
故障排查
“找不到命令:virex”
请确保 npm 的全局 bin 目录已添加到 PATH 中。运行 npm bin -g 查看位置。
身份验证问题
尝试退出登录后重新登录:
virex logout
virex login
构建失败
在部署前,先确认构建命令在本地可以正常运行:
npm run build
仍然卡住?加入我们的 Discord 获取社区帮助。