AGILE TEAM
Skip to content

工程脚手架 — 概览 & 快速开始

@agile-team/jh4j-cloud-cli(当前 0.6.1)是 JH4J Cloud 企业内部标准化项目脚手架,用于从受控模板快速创建结构一致、配置完整、可追溯的工程。一条命令即可生成 PC 业务子系统或移动端 H5 应用,避免手工复制目录再逐文件查找替换。

与 Skills Kit 的区别

本板块讲的是项目脚手架 @agile-team/jh4j-cloud-cli(命令 jh4j,用于 create / list / doctor / info)。 前端 Skills 安装器 @agile-team/wl-skills-kitinit / update / validate / fix / clean)是另一个工具,文档见 PC 端 — wl-skills-kit 工具


它解决什么问题

痛点脚手架做法
复制旧项目改不干净,残留他业务目录 / 标题 / 端口模板 + 非交互初始化,只改结构化配置
各项目目录结构、命名、规范参差统一受控模板,配置契约一致
私有 Registry、微前端版本对齐易错模板内置推荐值,版本对齐表约束
远程模板拉取不稳定GitHub → Gitee 主备源自动降级 + 本地缓存
生成中途失败留下半成品staging 事务化生成,成功才原子提升

核心能力

能力说明
模板直选直接展示 PC 管理端与移动端 H5,技术栈提示互不混淆
两种方式快速创建直接用模板推荐配置;自定义创建才展开必要参数
品牌终端青色到靛蓝的 JH4J 品牌主题,并兼容 NO_COLOR 与非 TTY
结果面板分区展示模板版本、实际配置、预设能力、下一步命令
非交互创建支持命令行参数和 JSON 配置文件,适用于 CI 与批量初始化
多源拉取支持本地目录、Git、HTTP 压缩包和离线压缩包
源站容灾内置模板按 GitHub → Gitee 顺序拉取,主源不可用时自动切换
模板缓存source + ref 缓存远程模板,支持查看、清理和强制刷新
安全生成在临时目录完成初始化与校验,成功后再原子写入目标目录
工程初始化默认不安装依赖;可初始化 main 分支并创建首次提交
来源追踪生成 .jhlc/project.json,记录模板版本、CLI 版本和创建参数

生成链路

text
jh4j create
  → 读取 Catalog
  → 选择 PC 管理端或移动端 H5 模板
  → 选择快速创建或自定义创建
  → 解析可用模板源
  → 拉取或读取缓存
  → 校验 template.manifest.json
  → 在 staging 目录执行模板初始化
  → 生成项目并初始化 Git
  → 开发者按需修改配置并手动安装依赖

环境要求

  • Node.js ^22.12.0 || ^24.0.0,推荐 Node.js 24
  • pnpm >=11.8.0
  • Git

建议先体检本机环境:

bash
npx @agile-team/jh4j-cloud-cli doctor

快速开始

无需全局安装:

bash
npx @agile-team/jh4j-cloud-cli create jh4j-ui-orders

或全局安装:

bash
pnpm add -g @agile-team/jh4j-cloud-cli
jh4j create jh4j-ui-orders

默认交互提供「快速创建 / 自定义创建」两种方式:

text
选择项目模板
├─ PC 管理端      Vue 3 · Vite · 微前端
└─ 移动端 H5      Vue 3 · Vite 7 · Vant 4

选择创建方式
├─ 快速创建(推荐)  使用模板推荐配置并立即生成
└─ 自定义创建        设置项目名、标题、端口和联调地址

快速创建不再提问:PC 使用 jh4j-ui-app、移动端使用 jh4j-mobile-app,标题、端口、联调地址、Registry、模块标识和各套环境配置全部采用模板推荐值。创建完成后默认不安装依赖,由开发者执行 pnpm install。详见 创建项目


当前可用模板

类型模板 ID模板文档
前端web.jh4j-mf-remoteVue 3 + Vite + Module Federation PC 业务子系统PC 模板概览
移动端mobile.robot-h5Vue 3 + Vite 7 + Vant 4 企业级 H5 应用移动端 H5 概览
后端暂未接入

命令总览

text
jh4j create [name]                    创建项目
jh4j list [--json]                    查看模板 Catalog
jh4j doctor [--json]                  检查 Node、pnpm、Git 与模板环境
jh4j info [path] [--json]             查看生成项目元数据
jh4j template validate [path]         校验模板契约
jh4j config list|get|set|unset|reset  管理用户配置
jh4j cache list|clear                 管理模板缓存

详细参数与用法见 命令参考


版块导航

  • 创建项目 — 交互 / 明确参数 / JSON 配置文件 / 预览计划 / 生成安全性
  • 命令参考 — list / doctor / info / template validate / config / cache
  • 模板来源 & Catalog — 来源解析、源站容灾、模板缓存、外部 Catalog
  • 模板接入规范 — manifest 契约、project.config、初始化脚本、元数据
  • 常见问题 — 模板拉取失败、手动安装依赖、强制指定模板源
📝 作者
杨晨誉
杨晨誉共享技术中心
工号:409322

You may not distribute, modify, or sell this software without permission.