# g2rain-app-cli(命令行工具)

g2rain-app-cli 是 CLI 脚手架工具,基于 g2rain-app-template 快速创建新的微前端子应用项目。它支持通过 qiankun 作为子应用加载时所需的模板化能力,并提供配套的初始化与环境变量配置方式。

# 功能特性

  • 微前端支持(模板内置 qiankun 适配)
  • Token 管理:从主应用接收 token 并初始化 token store
  • 子应用隔离:子应用环境下自动禁用 token 持久化,避免与主应用冲突
  • UI 框架:集成 Element Plus
  • 类型安全:内置 TypeScript 类型定义
  • Docker/签名支持:包含 Dockerfile 与 OpenResty Lua 签名示例

# 安装

支持两种主流用法:

  • npm create(推荐):
    • npm create g2rain-app@latest my-project
  • 在本地开发/调试(仓库方式):
    • npm link 进行全局命令联调,或直接全局安装

# 使用方法(创建项目)

# 交互式创建
npm create g2rain-app@latest

# 指定名称创建
npm create g2rain-app@latest my-app-name

# 自定义模板路径(G2RAIN_TEMPLATE_PATH)

当你需要使用远程模板仓库或自定义模板目录,可通过环境变量指定:

$env:G2RAIN_TEMPLATE_PATH="D:/path/to/g2rain-app-template"; npm create g2rain-app@latest my-app

# 初始化(创建后)

cd my-app-name
npm install

并在项目根目录创建 .env(开发)或 .env.production(生产)文件配置后端网关、SSO、Token 等基础信息。