Skip to content

创建项目 ​

@kevairy/cli 的 create 命令从 npm 下载 @kevairy/template,生成一个可以脱离源仓库运行的后台项目。默认下载 latest,建议使用空目录,并在创建后将结果提交到独立业务仓库。

前置条件 ​

  • Node.js 22.13 及以上的 22.x 版本,或 Node.js 24 及以上版本(推荐使用当前 LTS);
  • pnpm 10 或更高版本(推荐,也支持 npm 与 yarn)。

交互式创建 ​

安装并使用公开包:

bash
pnpm dlx @kevairy/cli create my-admin

在 Kevairy 源仓库根目录执行:

bash
pnpm create:app my-admin

命令会询问:

  1. 项目输出目录;
  2. package.json 名称;
  3. 页面显示名称;
  4. 包管理器;
  5. 是否立即安装依赖;
  6. 是否初始化 Git 仓库。

目标目录必须为空;脚手架不会覆盖已有项目文件。

非交互式创建 ​

在 CI/CD 或脚本中使用 --yes 跳过询问:

bash
pnpm create:app my-admin \
  --name my-admin \
  --display-name "My Admin" \
  --package-manager pnpm \
  --template-version 0.1.0 \
  --no-install \
  --no-git \
  --yes

完整参数见 CLI 选项。

启动新项目 ​

bash
cd my-admin
pnpm install # 创建时已经安装则跳过
pnpm dev

开发环境默认使用本地 Mock 认证:

text
账号:admin
密码:123456

创建完成后,后续操作都在新项目根目录执行,不再依赖 Kevairy 源仓库。

下一步 ​

  1. 了解生成项目结构;
  2. 在全局配置中替换名称和品牌资源;
  3. 按认证接入替换 Mock 适配器;
  4. 按路由与菜单添加业务页面;
  5. 运行项目测试完成基础验收。