@mrnpmjs/create

English | 简体中文

📦使用方式

方式一：npm create（推荐）

支持两种 create 写法，效果完全相同：

# 交互模式
npm create @mrnpmjs

# 交互模式-简写法（推荐）
npm create aix

带参数的用法：

# 指定项目名 + 模板
npm create aix my-project --template vue
npm create aix my-project --template vue --branch develop

# 指定项目名 + 自定义仓库
npm create aix my-project --repo https://gitee.com/your-org/your-repo.git
npm create aix my-project --repo https://gitee.com/your-org/your-repo.git --branch develop

方式二：npx

# 交互模式
npx @mrnpmjs/create

# 指定项目名 + 模板
npx @mrnpmjs/create my-project --template vue
npx @mrnpmjs/create my-project --template vue --branch develop

# 指定项目名 + 自定义仓库
npx @mrnpmjs/create my-project --repo https://gitee.com/your-org/your-repo.git
npx @mrnpmjs/create my-project --repo https://gitee.com/your-org/your-repo.git --branch develop

方式三：全局安装

npm install @mrnpmjs/create -g

create-mrnpmjs                 # 交互模式
create-mrnpmjs my-project --template vue

create-mrnpmjs history         # 查看历史

💡 使用 --repo 时，不指定 --branch 会自动使用远程仓库的默认分支（main 或 master），只有需要特定分支时才需指定。

内置模板

| 模板名 | 说明 | | ------------ | ---------------------------------- | | jeecg | JeecgBoot AI低代码平台 | | vben-admin | Vue 3 + TypeScript + Vite 项目模板 | | library | JavaScript/TypeScript 工具库模板 |

Options

Usage: @mrnpmjs/create [project-name] [options]

Options:
-t, --template <name> 模板名称（从注册表查找）
-r, --repo <url> 自定义远程仓库地址
-b, --branch <branch> Git 分支（默认: main）
-f, --force 覆盖已存在的目标目录
--no-git 跳过 Git 初始化
-V, --version 版本号
-h, --help 帮助

交互模式

不传任何参数时自动进入交互模式：

1. 输入项目名称
2. 选择模板来源（预设模板 / 自定义仓库）
3. 选择模板或输入仓库地址
4. 确认创建

💡 交互模式中选择「自定义仓库」时，分支输入框留空即可使用远程默认分支。

示例输出

Welcome to AiX Framework — Build Smarter, Ship Faster

T  Create AiX - Project Scaffolding Tool
|
*  输入项目名称：
? Project name: demo-web
|
*  选择模板来源：
? Select template source: Preset
|
*  选择预设模板：
? Select a template: web
|
*  确认分支：
? Use branch "master"? [Yes / No] Yes
|
*  确认创建项目？
? Create project with these settings? [Yes / No] Yes
|
*  是否初始化 Git？
? Initialize git repository? [Yes / No] Yes

==============================

T  Creating project...
|
o  [1/4] Downloading template...
|  ✓ template: vue
|
o  [2/4] Generating project...
|  ✓ Project files generated
|
o  [3/4] Initializing git repository...
|  ✓ Git repository initialized
|
o  [4/4] Done!
|  ✓ Done!
==============================

  Project created successfully!
  Q:\User\Desktop\demo-web

  Next steps:
    cd demo-web
    npm install
    npm run dev

历史记录

每次创建项目（成功或失败）都会自动记录到 ~/.create-aix/history.json，包含项目名称、模板来源、创建选项和结果状态等信息。

查看历史

# 查看最近 20 条记录
npm create aix history

# 查看全部记录
npm create aix history --all

# 清空
npm create aix history --clear