# jufubao-cli

**Repository Path**: e56buy_admin/jufubao-cli

## Basic Information

- **Project Name**: jufubao-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-20
- **Last Updated**: 2026-03-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# jfb-front

聚宝前端 CLI 工具 - 快速创建和管理前端项目

## 一、简介

`jfb-front` 是一个功能完整的前端 CLI 工具，提供项目创建、技能管理、文档管理三大核心功能。

**核心特性：**
- ✅ 支持创建后台管理系统（无登录/有登录）和前台项目
- ✅ 支持 Claude Code 和 Trae 双平台技能管理
- ✅ 支持后台/前项目文档自动匹配安装
- ✅ 交互式与参数化两种使用方式

---

## 二、安装

```bash
npm install -g jufubao-front
```

**环境要求：**
| 依赖 | 最低版本 | 推荐版本 |
|------|----------|----------|
| Node.js | 14.16.0 | 18.x |
| npm | 6.0.0 | 9.x |

**注意：** 安装包名为 `jufubao-front`，安装后使用 `jfb-front` 命令

**支持平台：**
| 系统 | 说明 |
|------|------|
| macOS | ✅ 完全支持 |
| Linux | ✅ 完全支持 |
| Windows | ✅ 支持（需安装 Git for Windows） |

**Windows 系统额外要求：**
- 安装 [Git for Windows](https://gitforwindows.org/)
- 配置 SSH 密钥（用于 Git 仓库访问）

---

## 三、命令列表

| 命令 | 说明 | 文档位置 |
|------|------|----------|
| `jfb-front create` | 创建新项目 | [§4.1](#41-创建项目) |
| `jfb-front skill install` | 安装全局技能 | [§4.2](#42-技能管理) |
| `jfb-front skill update` | 更新全局技能 | [§4.2](#42-技能管理) |
| `jfb-front docs install` | 安装项目文档 | [§4.3](#43-文档管理) |
| `jfb-front docs update` | 更新项目文档 | [§4.3](#43-文档管理) |

---

## 四、命令详情

### 4.1 创建项目

**项目类型：**

| 项目类型 | 参数值 | 状态 |
|----------|--------|------|
| 后台项目（无登录） | `admin` | ✅ 已完成 |
| 后台项目（有登录） | `admin-login` | ✅ 已完成 |
| 前台项目 | `front` | ⚠️ 已配置，暂未开放 |

**使用方法：**

```bash
# 交互式创建（推荐）
jfb-front create

# 参数指定类型创建
jfb-front create my-admin -t admin        # 无登录后台
jfb-front create my-admin -t admin-login  # 有登录后台
jfb-front create my-app -t front          # 前台项目

# 强制覆盖已存在的目录
jfb-front create my-project -f

# 自动安装项目文档
jfb-front create my-admin -t admin --docs
```

**参数说明：**

| 参数 | 简写 | 说明 |
|------|------|------|
| `--type` | `-t` | 项目类型：admin / admin-login / front |
| `--force` | `-f` | 强制覆盖已存在的目录 |
| `--docs` | `-d` | 自动安装项目文档（无需确认） |

**执行流程：**
1. 选择项目类型（交互式或参数指定）
2. 输入项目名称（参数指定则跳过）
3. 检查目录是否存在（存在则询问是否覆盖）
4. 下载项目模板
5. 修改 package.json 中的项目名称
6. 询问是否安装项目文档（根据项目类型自动匹配）
7. 输出成功信息

**文档自动匹配规则：**

| 项目类型 | 包含文档 | 说明 |
|----------|----------|------|
| `admin` | `admin-*` + 共用文档 | 后台专属文档 + 非 uni-* 开头的共用文档 |
| `front` | `uni-*` + 共用文档 | 前台专属文档 + 非 admin-* 开头的共用文档 |

---

### 4.2 技能管理

**支持平台：**

| 平台 | 安装路径 | 状态 |
|------|----------|------|
| Claude Code | `~/.claude/skills/` | ✅ 完全支持 |
| Trae | `~/.trae/skills/` | ⚠️ 仅备份，需 MCP 配置 |

**重要说明：**
- **Claude Code**: 安装后可直接使用
- **Trae**: Trae 使用 MCP (Model Context Protocol) 加载技能，`~/.trae/skills/` 仅作为备份目录
- 如需在 Trae 中使用技能，建议通过 Claude Code 集成方式配置

**技能仓库：** `git@codeup.aliyun.com:5ee9cdff4f5c9c1b178652c8/jufubao-ai-skills.git`
**技能目录：** `front/skills`

**使用方法：**

```bash
# 安装全局技能（交互式选择平台）
jfb-front skill install

# 更新全局技能（交互式选择平台）
jfb-front skill update
```

**注意事项：**
- 技能仓库地址需在 `src/config.js` 中配置
- 如显示"技能已安装"，请使用 `update` 命令更新
- 首次使用需配置 Git SSH 密钥

**Windows 系统 SSH 配置：**

```bash
# 1. 安装 Git for Windows (https://gitforwindows.org/)
# 2. 生成 SSH 密钥
ssh-keygen -t ed25519 -C "your_email@example.com"

# 3. 查看公钥内容
cat ~/.ssh/id_ed25519.pub

# 4. 将公钥添加到 Git 平台（阿里云 Codeup/Gitee）
# 5. 测试连接
ssh -T git@codeup.aliyun.com
```

---

### 4.3 文档管理

**安装路径：** `项目根目录/docs/modules/`

**文档仓库：** `git@codeup.aliyun.com:5ee9cdff4f5c9c1b178652c8/jufubao-ai-skills.git`
**文档目录：** `front/docs/modules`

**文档类型：**

| 类型 | 参数值 | 包含文件 |
|------|--------|----------|
| 后台项目文档 | `admin` | `admin-*` 专属文档 + 共用文档（router-guide.md、vuex-guide.md 等） |
| 前台项目文档 | `front` | `uni-*` 专属文档 + 共用文档（router-guide.md、vuex-guide.md 等） |

**使用方法：**

```bash
# 安装文档（交互式选择类型）
jfb-front docs install

# 指定类型安装
jfb-front docs install --type admin
jfb-front docs install --type front

# 更新项目文档
jfb-front docs update
```

**参数说明：**

| 参数 | 简写 | 说明 |
|------|------|------|
| `--type` | `-t` | 文档类型：admin / front |

---

## 五、目录结构

```
jfb-front/
├── bin/
│   └── index.js          # CLI 入口
├── src/
│   ├── commands/         # 命令模块
│   │   ├── create.js     # 创建项目
│   │   ├── skill.js      # 技能命令
│   │   └── docs.js       # 文档命令
│   ├── utils/
│   │   └── helper.js     # 工具函数
│   └── config.js         # 配置文件
├── docs/
│   ├── CONTRIB.md        # 开发者贡献指南
│   ├── RUNBOOK.md        # 运维手册
│   └── modules/          # 项目文档目录
├── package.json
├── README.md
└── LICENSE
```

---

## 六、相关文档

| 文档 | 路径 | 说明 |
|------|------|------|
| 开发者贡献指南 | `docs/CONTRIB.md` | 开发工作流程、测试流程、代码规范 |
| 运维手册 | `docs/RUNBOOK.md` | 部署流程、监控告警、常见问题、应急预案 |
| CLI 使用手册 | `docs/modules/cli-guide.md` | CLI 详细使用手册 |
| 开发指南 | `docs/modules/dev-guide.md` | 本地开发、添加命令、工具函数 |
| 配置说明 | `docs/modules/config-guide.md` | 配置文件详解、修改指南 |

---

## 七、常见问题

### 7.1 Git 下载失败
**原因：** SSH 密钥未配置或仓库地址错误
**解决：**
```bash
ssh-keygen -t ed25519 -C "your_email@example.com"
ssh -T git@codeup.aliyun.com
```

### 7.2 目录已存在
**解决：** 使用 `-f` 参数强制覆盖
```bash
jfb-front create my-project -f
```

### 7.3 技能/文档已安装
**解决：** 使用 `update` 命令更新
```bash
jfb-front skill update
jfb-front docs update
```

### 7.4 Windows 系统注意事项

**问题：** Windows 系统提示 `git` 命令不存在
**解决：** 安装 [Git for Windows](https://gitforwindows.org/)

**问题：** Windows 系统 SSH 连接失败
**解决：**
1. 打开 Git Bash
2. 运行 `ssh-keygen -t ed25519 -C "your_email@example.com"`
3. 将 `~/.ssh/id_ed25519.pub` 内容添加到 Git 平台
4. 运行 `ssh -T git@codeup.aliyun.com` 测试连接

**问题：** Windows 系统路径权限问题
**解决：** 以管理员身份运行命令行工具

### 7.5 Trae 技能无法读取

**问题：** Trae 安装技能后无法使用

**原因：** Trae 使用 MCP (Model Context Protocol) 加载技能，`~/.trae/skills/` 仅作为备份目录

**解决方案：**
1. **推荐使用 Claude Code** - 技能已正确安装到 `~/.claude/skills/`
2. **配置 Trae MCP** - 需在 Trae 设置中配置 MCP 服务器路径（需 Trae 官方支持）

---

## 八、版本信息

| 版本 | 日期 | 说明 |
|------|------|------|
| 1.0.1 | 2026-03-26 | 文档完善版 |
| 1.0.0 | 2025-03-20 | 初始版本 |

详细更新日志请查看：[docs/modules/CHANGELOG.md](docs/modules/CHANGELOG.md)

---

## License

MIT