@zjex/git-workflow 0.2.23 → 0.3.0

package/README.md

@@ -1,11 +1,18 @@
 # @zjex/git-workflow
 
+<p align="center">
+  <a href="https://iamzjt-front-end.github.io/git-workflow/">
+    <img src="./zjex-logo.svg" alt="zjex logo" width="200" />
+  </a>
+</p>
+
 <p align="center">
   <a href="https://www.npmjs.com/package/@zjex/git-workflow"><img src="https://img.shields.io/npm/v/@zjex/git-workflow?style=flat&colorA=18181B&colorB=F0DB4F" alt="npm version"></a>
   <a href="https://www.npmjs.com/package/@zjex/git-workflow"><img src="https://img.shields.io/npm/dt/@zjex/git-workflow?style=flat&colorA=18181B&colorB=3178C6" alt="npm downloads"></a>
   <a href="https://github.com/iamzjt-front-end/git-workflow"><img src="https://img.shields.io/github/stars/iamzjt-front-end/git-workflow?style=flat&colorA=18181B&colorB=F59E0B" alt="github stars"></a>
   <a href="https://github.com/iamzjt-front-end/git-workflow/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@zjex/git-workflow?style=flat&colorA=18181B&colorB=10B981" alt="license"></a>
   <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-339933?style=flat&logo=node.js&logoColor=white&colorA=18181B" alt="node version"></a>
+  <a href="https://github.com/iamzjt-front-end/git-workflow/actions"><img src="https://img.shields.io/badge/tests-231%20passed-success?style=flat&colorA=18181B" alt="tests"></a>
   <a href="https://github.com/iamzjt-front-end/git-workflow/issues"><img src="https://img.shields.io/github/issues/iamzjt-front-end/git-workflow?style=flat&colorA=18181B&colorB=EC4899" alt="issues"></a>
 </p>
 
@@ -14,11 +21,14 @@
 </p>
 
 <p align="center">
-  <a href="#✨-特性">特性</a> •
   <a href="#⚡️-快速开始">快速开始</a> •
-  <a href="#📚-命令详解">命令详解</a> •
-  <a href="#⚙️-配置文件">配置文件</a> •
-  <a href="#💡-最佳实践">最佳实践</a>
+  <a href="#✨-核心特性">核心特性</a> •
+  <a href="#📚-完整文档">完整文档</a> •
+  <a href="#🤝-贡献">贡献</a>
+</p>
+
+<p align="center">
+  <strong>📚 <a href="https://iamzjt-front-end.github.io/git-workflow/">完整文档</a> | 🚀 <a href="https://iamzjt-front-end.github.io/git-workflow/guide/getting-started">快速开始</a> | 📖 <a href="https://iamzjt-front-end.github.io/git-workflow/commands/">命令参考</a> | ⚙️ <a href="https://iamzjt-front-end.github.io/git-workflow/config/">配置指南</a></strong>
 </p>
 
 ---
@@ -36,65 +46,32 @@
 
 **git-workflow** 就是为解决这些痛点而生的。它提供了一套简洁的命令，让你专注于编码，而不是 Git 操作。
 
-## ✨ 特性
-
-### 核心功能
-
-- ⚡️ **极速上手** - 零配置开箱即用，交互式菜单引导操作
-- 🤖 **AI 智能提交** - 使用 AI 自动分析代码变更生成 commit message（支持 GitHub Models、OpenAI 等）
-- 🎯 **规范命名** - 自动生成带日期的规范分支名（`feature/20260109-PROJ-123-add-login`）
-- 🏷️ **智能版本** - 自动识别当前版本，交互式选择下一版本（支持 semver + 预发布版本）
-- 📝 **规范提交** - 遵循 Conventional Commits + Gitmoji，提交信息更清晰
-- 🗑️ **批量清理** - 一键删除本地+远程分支，按最近使用排序
-- 💾 **Stash 管理** - 可视化管理 stash，支持预览、应用、创建分支等操作
-- 🔔 **版本提醒** - 自动检测新版本，一键更新
-
-### 分支管理
-
-- ✅ 自动检测基础分支（main/master）
-- ✅ 支持自定义基础分支（`--base develop`）
-- ✅ 自动处理未提交更改（询问是否 stash）
-- ✅ 创建后可选自动推送到远程
-- ✅ 删除时自动检测并清理远程分支
-- ✅ 按最近使用时间排序，方便选择
-
-### 🏷️ Tag 管理
-
-- ✅ 自动检测现有 tag 前缀（v、release-、@scope/等）
-- ✅ 支持多种 tag 前缀，灵活适配不同项目
-- ✅ 智能版本递增（patch/minor/major）
-- ✅ 支持预发布版本（alpha/beta/rc）
-- ✅ 预发布版本可升级或转正式版本
-- ✅ 自动推送到远程
-- ✅ 支持删除和修改 tag
-
-### Commit 管理
-
-- ✅ AI 自动生成 commit message（2-3 秒完成）
-- ✅ 支持 4 种 AI 提供商（GitHub/OpenAI/Claude/Ollama）
-- ✅ 手动模式支持 11 种提交类型
-- ✅ 自动添加 Gitmoji 表情
-- ✅ 支持 scope、详细描述、关联 Issue
-- ✅ 支持标记破坏性变更（BREAKING CHANGE）
-- ✅ 提交前预览，可取消
-- ✅ 自动暂存或手动选择文件
-
-### 配置灵活
-
-- ⚙️ 支持项目级配置文件（`.gwrc.json`）
-- ⚙️ 不同项目可使用不同规范
-- ⚙️ 支持自定义分支前缀、ID 标签等
-- ⚙️ 支持自定义 commit emoji
-- ⚙️ 支持配置 AI 提供商和模型
-
-### 用户体验
-
-- 🎨 优雅的命令行界面
-- 🎯 键盘快捷操作（方向键、空格、回车）
-- 🔍 实时搜索和过滤
-- 📋 详细的操作提示和错误信息
-- 🚫 优雅处理 Ctrl+C 退出
-- 📦 轻量依赖，安装快速
+## ✨ 核心特性
+
+### 🤖 AI 智能提交
+- 使用 AI 自动分析代码变更生成 commit message（2-3 秒完成）
+- 支持 GitHub Models（免费）、OpenAI、Claude、Ollama 等多种提供商
+- 遵循 Conventional Commits + Gitmoji 规范
+
+### 🎯 规范分支管理
+- 自动生成带日期的规范分支名（`feature/20260109-PROJ-123-add-login`）
+- 智能检测基础分支（main/master），支持自定义
+- 一键删除本地+远程分支，按最近使用排序
+
+### 🏷️ 智能版本管理
+- 自动识别当前版本，交互式选择下一版本
+- 支持 semver + 预发布版本（alpha/beta/rc）
+- 自动检测 tag 前缀，支持多种命名规范
+
+### 💾 可视化 Stash 管理
+- 清晰的交互式界面，告别难读的 `git stash list`
+- 支持预览、应用、创建分支等操作
+- 智能处理未跟踪文件
+
+### ⚙️ 灵活配置
+- 支持全局配置（一次配置，所有项目生效）
+- 支持项目级配置（团队统一规范）
+- 零配置开箱即用，交互式菜单引导操作
 
 ## ⚡️ 快速开始
 
@@ -175,33 +152,16 @@ gw
   [3] 🗑️  删除分支               gw d
   [4] 📝 提交代码               gw c
   [5] 🏷️  创建 tag               gw t
-  [6] 🗑️  删除 tag               gw td
-  [7] ✏️  修改 tag               gw tu
-  [8] 📋 列出 tags              gw ts
-  [9] 📦 发布版本               gw r
-  [a] 💾 管理 stash             gw s
-  [b] ⚙️  初始化配置             gw init    # 可选择全局或项目配置
-  [0] ❓ 帮助
-  [q] 退出
+  ...
 
 # ✨ 创建 feature 分支
 gw f
 ? 请输入 Story ID (可跳过): PROJ-123
 ? 请输入描述: add-user-login
 ✔ 分支创建成功: feature/20260109-PROJ-123-add-user-login
-? 是否推送到远程? 是
-✔ 已推送到远程
 
-# 📝 提交代码（AI 模式）
+# 📝 AI 智能提交
 gw c
-已暂存的文件:
-  src/auth.ts
-  src/login.ts
-────────────────────────────────────────
-? 选择 commit 方式:
-❯ 🤖 AI 自动生成 commit message
-  ✍️  手动编写 commit message
-
 ✔ AI 生成完成
 
 AI 生成的 commit message:
@@ -209,932 +169,43 @@ AI 生成的 commit message:
 ────────────────────────────────────────
 ? 使用这个 commit message?
 ❯ ✅ 使用
-  ❌ 不使用，切换到手动模式
 
 ✔ 提交成功
-commit: a1b2c3d
 
 # 🏷️ 创建 tag
 gw t
-? 选择 tag 前缀: v (最新: v1.2.0)
 ? 选择版本类型:
 ❯ patch   → v1.2.1
   minor   → v1.3.0
   major   → v2.0.0
-  alpha   → v1.2.1-alpha.1
-  beta    → v1.2.1-beta.1
-  rc      → v1.2.1-rc.1
 
 ✔ Tag 创建成功: v1.2.1
-✔ Tag 已推送: v1.2.1
-
-# 🗑️ 删除分支
-gw d
-? 选择要删除的分支:
-❯ feature/20260105-old-feature (本地+远程) 3 days ago
-  feature/20260103-test (仅本地) 5 days ago
-
-✔ 本地分支已删除: feature/20260105-old-feature
-✔ 远程分支已删除: origin/feature/20260105-old-feature
-
-# 💾 管理 stash
-gw s
-共 2 个 stash:
-
-? 选择 stash:
-❯ [0] main fix login bug (3 文件) 2 hours ago
-  [1] develop add feature (5 文件) 1 day ago
-  + 创建新 stash
-  取消
-
-? 操作:
-❯ 应用 (保留 stash)
-  弹出 (应用并删除)
-  创建分支
-  查看差异
-  删除
-  返回列表
-
-✔ Stash 已应用
-```
-
-## 📚 命令详解
-
-### 📋 交互式菜单
-
-直接运行 `gw` 显示交互式菜单，适合新手快速上手：
-
-```bash
-gw
 ```
 
-显示 ZJEX Logo 和完整的操作菜单，使用方向键选择，回车确认。
-
-### 🌿 分支命令
-
-| 命令                           | 别名              | 说明              |
-| ------------------------------ | ----------------- | ----------------- |
-| `gw feature [--base <branch>]` | `gw feat`, `gw f` | 创建 feature 分支 |
-| `gw hotfix [--base <branch>]`  | `gw fix`, `gw h`  | 创建 hotfix 分支  |
-| `gw delete [branch]`           | `gw del`, `gw d`  | 删除本地/远程分支 |
-
-#### 创建分支
-
-```bash
-# 基于 main/master 创建（自动检测）
-gw f
-
-# 基于指定分支创建
-gw f --base develop
-gw fix --base release/1.0
-```
+## 📚 完整文档
 
-如果检测到未提交的更改，会询问是否自动暂存 (stash)：
+想了解更多功能和用法？查看我们的完整文档：
 
-```bash
-gw f
-# 检测到未提交的更改:
-#  M src/index.ts
-# ────────────────────────────────────────
-# ? 是否暂存 (stash) 这些更改后继续?
-#   是
-#   否，取消操作
-# ✔ 更改已暂存，切换分支后可用 gw s 恢复
-```
+- 📖 **[完整文档](https://iamzjt-front-end.github.io/git-workflow/)** - 详细的功能介绍和使用指南
+- 🚀 **[快速开始](https://iamzjt-front-end.github.io/git-workflow/guide/getting-started)** - 5 分钟上手指南
+- 📋 **[命令参考](https://iamzjt-front-end.github.io/git-workflow/commands/)** - 所有命令的详细说明
+- ⚙️ **[配置指南](https://iamzjt-front-end.github.io/git-workflow/config/)** - 配置文件详解和最佳实践
+- 🤖 **[AI 配置](https://iamzjt-front-end.github.io/git-workflow/config/ai-config)** - AI 提供商配置指南
+- 🌿 **[分支管理](https://iamzjt-front-end.github.io/git-workflow/guide/branch-management)** - 分支命名规范和管理技巧
+- 🏷️ **[Tag 管理](https://iamzjt-front-end.github.io/git-workflow/guide/tag-management)** - 版本标签管理和语义化版本
+- 💾 **[Stash 管理](https://iamzjt-front-end.github.io/git-workflow/guide/stash-management)** - 可视化 stash 操作指南
+- 👥 **[团队协作](https://iamzjt-front-end.github.io/git-workflow/guide/team-collaboration)** - 团队配置和最佳实践
 
-分支命名格式：
+## 🛠️ 开发与贡献
 
-```
-feature/YYYYMMDD-<ID>-<描述>
-hotfix/YYYYMMDD-<ID>-<描述>
+想要参与开发或了解更多技术细节？查看我们的开发文档：
 
-# ID 可跳过
-feature/YYYYMMDD-<描述>
-```
+- 🔧 **[开发指南](https://iamzjt-front-end.github.io/git-workflow/guide/development)** - 本地开发环境搭建
+- 🧪 **[测试指南](https://iamzjt-front-end.github.io/git-workflow/guide/testing)** - 测试框架和覆盖率
+- 📋 **[API 文档](https://iamzjt-front-end.github.io/git-workflow/api/)** - 内部 API 参考
+- 🤝 **[贡献指南](https://iamzjt-front-end.github.io/git-workflow/guide/contributing)** - 如何参与贡献
 
-#### 删除分支
-
-```bash
-# 交互式选择（按最近使用排序）
-gw d
-
-# 直接删除指定分支
-gw d feature/20260101-old-feature
-```
-
-删除时会自动检测远程分支是否存在，并询问是否一并删除。
-
-### 🏷️ Tag 命令
-
-| 命令               | 别名    | 说明                     |
-| ------------------ | ------- | ------------------------ |
-| `gw tags [prefix]` | `gw ts` | 列出 tag（可按前缀过滤） |
-| `gw tag [prefix]`  | `gw t`  | 交互式创建 tag           |
-| `gw tag:delete`    | `gw td` | 交互式删除 tag           |
-| `gw tag:update`    | `gw tu` | 交互式修改 tag 消息      |
-
-#### 列出 Tag
-
-```bash
-# 列出所有 tag
-gw ts
-
-# 按前缀过滤
-gw ts v
-gw ts release-
-```
-
-#### 创建 Tag
-
-```bash
-# 交互式选择前缀和版本
-gw t
-
-# 指定前缀
-gw t v
-```
-
-**自动检测前缀：**
-
-工具会自动检测仓库中已有的 tag 前缀，并智能推荐：
-
-```bash
-gw t
-# 检测到以下 tag 前缀:
-# ? 选择 tag 前缀:
-# ❯ v (最新: v1.2.0)
-#   release- (最新: release-1.0.0)
-#   + 使用新前缀
-```
-
-如果仓库没有任何 tag，会引导创建初始版本：
-
-```bash
-gw t
-# 当前仓库没有 tag，请输入前缀 (如 v): v
-# ? 选择初始版本号:
-#   v0.0.1
-#   v0.1.0
-#   v1.0.0
-#   自定义...
-```
-
-支持的版本类型：
-
-| 当前版本        | 可选操作                                                                                                                             |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| `v1.2.3`        | patch → `v1.2.4`<br>minor → `v1.3.0`<br>major → `v2.0.0`<br>alpha → `v1.2.4-alpha.1`<br>beta → `v1.2.4-beta.1`<br>rc → `v1.2.4-rc.1` |
-| `v1.2.4-beta.1` | pre → `v1.2.4-beta.2`<br>release → `v1.2.4`<br>patch/minor/major...                                                                  |
-
-#### 删除 Tag
-
-```bash
-# 交互式选择要删除的 tag
-gw td
-
-# 示例流程
-? 选择要删除的 tag:
-❯ v1.2.0 (2 days ago)
-  v1.1.0 (1 week ago)
-  v1.0.0 (2 weeks ago)
-
-? 确认删除 tag v1.2.0?
-❯ 是，删除本地和远程
-  仅删除本地
-  取消
-
-✔ 本地 tag 已删除: v1.2.0
-✔ 远程 tag 已删除: origin/v1.2.0
-```
-
-#### 修改 Tag
-
-```bash
-# 交互式选择要修改的 tag
-gw tu
-
-# 示例流程
-? 选择要修改的 tag:
-❯ v1.2.0 Release v1.2.0 (2 days ago)
-  v1.1.0 Release v1.1.0 (1 week ago)
-
-当前消息: Release v1.2.0
-? 输入新的 tag 消息: Release v1.2.0 - Bug fixes
-
-✔ Tag 消息已更新: v1.2.0
-✔ 已推送到远程
-```
-
-### 📦 版本命令
-
-| 命令         | 别名   | 说明                                |
-| ------------ | ------ | ----------------------------------- |
-| `gw release` | `gw r` | 交互式选择版本号并更新 package.json |
-
-```bash
-gw r
-# 当前版本: 0.0.1
-# ? 选择新版本:
-#   patch   → 0.0.2
-#   minor   → 0.1.0
-#   major   → 1.0.0
-#   alpha   → 0.0.2-alpha.1
-#   beta    → 0.0.2-beta.1
-#   rc      → 0.0.2-rc.1
-# ✓ 版本号已更新: 0.0.1 → 0.0.2
-```
-
-### ⚙️ 配置命令
-
-| 命令      | 说明                                             |
-| --------- | ------------------------------------------------ |
-| `gw init` | 交互式初始化配置文件（可选择全局配置或项目配置） |
-
-### 🔄 更新命令
-
-| 命令        | 别名     | 说明                 |
-| ----------- | -------- | -------------------- |
-| `gw update` | `gw upt` | 检查并更新到最新版本 |
-
-```bash
-# 创建全局配置（推荐，一次配置所有项目生效）
-gw init
-# 选择 "全局配置（所有项目生效）"
-# 配置保存到 ~/.gwrc.json
-
-# 创建项目配置（仅当前项目生效）
-gw init
-# 选择 "项目配置（仅当前项目）"
-# 配置保存到 .gwrc.json
-```
-
-#### 更新命令
-
-```bash
-# 检查并更新到最新版本
-gw update
-
-# 或使用别名
-gw upt
-```
-
-**更新流程：**
-
-```bash
-gw update
-
-🔍 检查更新...
-
-┌─────────────────────────────────┐
-│                                 │
-│   🎉 发现新版本！               │
-│                                 │
-│   0.2.16  →  0.2.17             │
-│                                 │
-└─────────────────────────────────┘
-
-✔ 更新成功！
-
-┌─────────────────────────────────┐
-│                                 │
-│   ✨ 更新完成！                 │
-│                                 │
-│   请重新打开终端使用新版本      │
-│                                 │
-└─────────────────────────────────┘
-```
-
-**说明：**
-
-- 自动检测最新版本
-- 如果已是最新版本，显示提示
-- 如果有新版本，自动更新
-- 更新成功后提示重新打开终端
-
-**配置流程：**
-
-```bash
-gw init
-
-⚙️  初始化 git-workflow 配置
-
-? 选择配置范围:
-❯ 全局配置（所有项目生效）      # 推荐！配置一次，所有项目都能用
-  项目配置（仅当前项目）         # 为特定项目自定义配置
-
-# 然后按提示配置各项参数
-# 包括：分支前缀、ID 要求、自动推送、AI commit 等
-```
-
-### 💾 Stash 命令
-
-| 命令       | 别名            | 说明             |
-| ---------- | --------------- | ---------------- |
-| `gw stash` | `gw s`, `gw st` | 交互式管理 stash |
-
-原生 `git stash list` 输出难以阅读，`gw stash` 提供清晰的交互式界面：
-
-```bash
-gw st
-# 共 3 个 stash:
-#
-# ? 选择 stash:
-#   [0] main fix login bug (3 文件) 2 hours ago
-#   [1] develop add new feature (5 文件) 1 day ago
-#   [2] main WIP (1 文件) 3 days ago
-#   + 创建新 stash
-#   取消
-```
-
-选择后显示详情并提供操作：
-
-```bash
-# Stash #0
-# 分支: main
-# 消息: fix login bug
-# 时间: 2 hours ago
-# 文件 (3):
-#   • src/auth.ts
-#   • src/login.ts
-#   • tests/auth.test.ts
-# ────────────────────────────────────────
-# ? 操作:
-#   应用 (保留 stash)
-#   弹出 (应用并删除)
-#   创建分支          <- 复用 feature/hotfix 命名规范
-#   查看差异          <- 查看后返回菜单
-#   删除
-#   返回列表
-#   取消
-```
-
-创建 stash 时，如果检测到未跟踪的新文件，会询问是否一并 stash。
-
-### 📝 Commit 命令
-
-| 命令        | 别名            | 说明                                        |
-| ----------- | --------------- | ------------------------------------------- |
-| `gw commit` | `gw c`, `gw cm` | 交互式提交 (Conventional Commits + Gitmoji) |
-
-遵循 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/) 规范，并自动添加 [Gitmoji](https://gitmoji.dev/) 表情：
-
-#### 🤖 AI 自动生成（推荐）
-
-使用 AI 自动分析代码变更生成 commit message：
-
-```bash
-gw c
-# 已暂存的文件:
-#   src/ai-service.ts
-#   src/commands/commit.ts
-# ────────────────────────────────────────
-# ? 选择 commit 方式:
-# ❯ 🤖 AI 自动生成 commit message
-#   ✍️  手动编写 commit message
-#
-# ✔ AI 生成完成
-#
-# AI 生成的 commit message:
-# feat(ai): 添加 AI commit message 自动生成功能
-# ────────────────────────────────────────
-# ? 使用这个 commit message?
-# ❯ ✅ 使用
-#   ❌ 不使用，切换到手动模式
-```
-
-**特点：**
-
-- ⚡️ 快速：2-3 秒生成
-- 🎯 准确：自动识别 feat/fix/docs 等类型
-- 📝 规范：符合 Conventional Commits
-- 🇨🇳 支持中英文
-- 🔄 可预览、可拒绝、可降级到手动模式
-
-**支持的 AI 提供商：**
-
-- **GitHub Models**（免费，推荐）
-  - 使用 GitHub 账号，每天 150 次免费
-  - 需要配置 GitHub Token（工具会引导你获取）
-  - 获取地址：https://github.com/settings/tokens/new
-- **OpenAI**（付费）
-  - 需要配置 OpenAI API Key
-  - 获取地址：https://platform.openai.com/api-keys
-- **Claude**（付费）
-  - 需要配置 Claude API Key
-  - 获取地址：https://console.anthropic.com/
-- **Ollama**（本地）
-  - 需要安装 Ollama，无需 API key
-  - 安装地址：https://ollama.com/
-
-#### ✍️ 手动编写
-
-```bash
-gw c
-# 已暂存的文件:
-#   src/index.ts
-#   src/utils.ts
-# ────────────────────────────────────────
-# ? 选择 commit 方式:
-#   🤖 AI 自动生成 commit message
-# ❯ ✍️  手动编写 commit message
-#
-# ? 选择提交类型:
-#   ✨  feat       新功能
-#   🐛  fix        修复 Bug
-#   📝  docs       文档更新
-#   💄  style      代码格式 (不影响功能)
-#   ♻️  refactor   重构 (非新功能/修复)
-#   ⚡️  perf       性能优化
-#   ✅  test       测试相关
-#   📦  build      构建/依赖相关
-#   👷  ci         CI/CD 相关
-#   🔧  chore      其他杂项
-#   ⏪  revert     回退提交
-# ? 输入影响范围 scope (可跳过): auth
-# ? 输入简短描述: add login validation
-# ? 输入详细描述 (可跳过):
-# ? 是否包含破坏性变更 (BREAKING CHANGE)?
-# ❯ 否
-#   是
-# ? 关联 Issue (如 #123, 可跳过): #42
-# ────────────────────────────────────────
-# 提交信息预览:
-# ✨ feat(auth): add login validation
-#
-# #42
-# ────────────────────────────────────────
-# ? 确认提交?
-# ❯ ✅ 确认提交
-#   ❌ 取消
-# ✔ 提交成功
-# commit: a1b2c3d
-```
-
-#### 自动暂存
-
-如果没有暂存的更改，根据配置决定行为：
-
-**默认行为（`autoStage: true`）：**
-
-```bash
-gw c
-# 没有暂存的更改
-# ────────────────────────────────────────
-# 未暂存的文件:
-#   M src/index.ts
-#   M src/utils.ts
-# ────────────────────────────────────────
-# ✔ 已自动暂存所有更改
-```
-
-**手动选择文件（`autoStage: false`）：**
-
-```bash
-gw c
-# 没有暂存的更改
-# ────────────────────────────────────────
-# 未暂存的文件:
-#   M src/index.ts
-#   M src/utils.ts
-# ────────────────────────────────────────
-# ? 选择要暂存的文件: (使用空格选择)
-#   ◉ M src/index.ts
-#   ◉ M src/utils.ts
-# ✔ 已暂存 2 个文件
-```
-
-## ⚙️ 配置文件
-
-git-workflow 支持两种配置方式：
-
-### 配置优先级
-
-1. **项目配置**（`.gwrc.json` / `.gwrc` / `gw.config.json`）- 仅当前项目生效
-2. **全局配置**（`~/.gwrc.json`）- 所有项目生效
-3. **默认配置** - 内置默认值
-
-**配置合并规则：** 项目配置 > 全局配置 > 默认配置
-
-### 快速开始
-
-```bash
-# 创建全局配置（推荐）
-gw init
-# 选择 "全局配置（所有项目生效）"
-# 配置一次，所有项目都能使用 AI commit 等功能
-
-# 为特定项目创建自定义配置
-cd your-project
-gw init
-# 选择 "项目配置（仅当前项目）"
-# 项目配置会覆盖全局配置
-```
-
-### 配置文件位置
-
-| 类型     | 位置                                      | 说明                                 |
-| -------- | ----------------------------------------- | ------------------------------------ |
-| 全局配置 | `~/.gwrc.json`                            | 对所有项目生效，无需在每个项目中配置 |
-| 项目配置 | `.gwrc.json` / `.gwrc` / `gw.config.json` | 仅当前项目生效，可覆盖全局配置       |
-
-**查找顺序：** 当前目录 → Git 仓库根目录 → 用户主目录
-
-### 使用场景
-
-**全局配置适合：**
-
-- AI commit 配置（API key、提供商等）
-- 个人习惯配置（emoji、自动暂存等）
-- 通用的分支命名规范
-
-**项目配置适合：**
-
-- 团队统一的分支规范
-- 项目特定的 ID 要求
-- 特殊的分支前缀
-
-### 完整配置示例
-
-```json
-{
-  "baseBranch": "develop",
-  "featurePrefix": "feature",
-  "hotfixPrefix": "hotfix",
-  "requireId": true,
-  "featureIdLabel": "Story ID",
-  "hotfixIdLabel": "Issue ID",
-  "defaultTagPrefix": "v",
-  "autoPush": true,
-  "autoStage": true,
-  "useEmoji": true,
-  "aiCommit": {
-    "enabled": true,
-    "provider": "github",
-    "apiKey": "",
-    "model": "gpt-4o-mini",
-    "language": "zh-CN",
-    "maxTokens": 200
-  }
-}
-```
-
-### 配置项说明
-
-| 配置项             | 类型      | 默认值       | 说明                                                                            |
-| ------------------ | --------- | ------------ | ------------------------------------------------------------------------------- |
-| `baseBranch`       | `string`  | 自动检测     | 默认基础分支，不设置则自动检测 main/master                                      |
-| `featurePrefix`    | `string`  | `"feature"`  | feature 分支前缀                                                                |
-| `hotfixPrefix`     | `string`  | `"hotfix"`   | hotfix 分支前缀                                                                 |
-| `requireId`        | `boolean` | `false`      | 是否强制要求填写 ID（Story ID/Issue ID）。开启后创建分支时必须填写 ID，不能跳过 |
-| `featureIdLabel`   | `string`  | `"Story ID"` | feature 分支 ID 提示文字                                                        |
-| `hotfixIdLabel`    | `string`  | `"Issue ID"` | hotfix 分支 ID 提示文字                                                         |
-| `defaultTagPrefix` | `string`  | -            | 默认 tag 前缀，设置后跳过选择步骤                                               |
-| `autoPush`         | `boolean` | -            | 创建分支后是否自动推送到远程。`true` 自动推送，`false` 不推送，不设置则每次询问 |
-| `autoStage`        | `boolean` | `true`       | commit 时是否自动暂存所有更改                                                   |
-| `useEmoji`         | `boolean` | `true`       | commit 时是否使用 emoji                                                         |
-| `commitEmojis`     | `object`  | -            | 自定义各类型 commit 的 emoji                                                    |
-| `aiCommit`         | `object`  | -            | AI commit 配置                                                                  |
-
-#### AI Commit 配置项
-
-| 配置项               | 类型      | 默认值     | 说明                                                 |
-| -------------------- | --------- | ---------- | ---------------------------------------------------- |
-| `aiCommit.enabled`   | `boolean` | `true`     | 是否启用 AI commit 功能                              |
-| `aiCommit.provider`  | `string`  | `"github"` | AI 提供商：`github` / `openai` / `claude` / `ollama` |
-| `aiCommit.apiKey`    | `string`  | -          | API key，留空使用内置 key                            |
-| `aiCommit.model`     | `string`  | 根据提供商 | 模型名称                                             |
-| `aiCommit.language`  | `string`  | `"zh-CN"`  | 生成语言：`zh-CN` / `en-US`                          |
-| `aiCommit.maxTokens` | `number`  | `200`      | 最大 token 数                                        |
-
-### 常见配置场景
-
-<details>
-<summary><b>场景一：全局启用 AI Commit（强烈推荐）</b></summary>
-
-**一次配置，所有项目生效！**
-
-```bash
-# 1. 创建全局配置
-gw init
-# 选择 "全局配置（所有项目生效）"
-
-# 2. 配置 AI commit
-# 选择 AI 提供商: GitHub Models（免费，推荐）
-#
-# 💡 如何获取 GitHub Token:
-#   1. 访问: https://github.com/settings/tokens/new
-#   2. 勾选 'repo' 权限
-#   3. 生成并复制 token
-#
-# 输入你的 GitHub Token: ghp_xxxxxxxxxxxx
-# 选择语言: 中文
-```
-
-生成的全局配置文件 `~/.gwrc.json`：
-
-```json
-{
-  "featurePrefix": "feature",
-  "hotfixPrefix": "hotfix",
-  "requireId": false,
-  "featureIdLabel": "Story ID",
-  "hotfixIdLabel": "Issue ID",
-  "autoStage": true,
-  "useEmoji": true,
-  "aiCommit": {
-    "enabled": true,
-    "provider": "github",
-    "language": "zh-CN",
-    "model": "gpt-4o-mini"
-  }
-}
-```
-
-**效果：**
-
-- ✅ 所有项目都能使用 AI commit
-- ✅ 无需在每个项目中重复配置
-- ✅ 新项目自动继承配置
-- ✅ 独享 GitHub Models 限额（每天 150 次）
-
-**GitHub Token 权限说明：**
-
-- 只需要勾选 `repo` 权限
-- Token 仅用于调用 GitHub Models API
-- 不会访问你的代码仓库
-
-**手动编辑配置文件：**
-
-```json
-{
-  "aiCommit": {
-    "enabled": true,
-    "provider": "github",
-    "apiKey": "ghp_your_token_here",
-    "language": "zh-CN"
-  }
-}
-```
-
-获取 GitHub Token：https://github.com/settings/tokens/new
-
-</details>
-
-<details>
-<summary><b>场景二：团队项目配置（覆盖全局配置）</b></summary>
-
-**全局配置 + 项目配置 = 灵活组合**
-
-假设你已经有全局配置（启用了 AI commit），现在要为团队项目添加特定规范：
-
-```bash
-cd team-project
-gw init
-# 选择 "项目配置（仅当前项目）"
-```
-
-项目配置 `.gwrc.json`：
-
-```json
-{
-  "requireId": true,
-  "featureIdLabel": "Jira ID",
-  "hotfixIdLabel": "Bug ID",
-  "autoPush": true,
-  "baseBranch": "develop"
-}
-```
-
-**最终生效的配置：**
-
-- ✅ AI commit 配置来自全局配置
-- ✅ 分支规范来自项目配置
-- ✅ 项目配置覆盖全局配置的同名字段
-
-**提交到仓库：**
-
-```bash
-git add .gwrc.json
-git commit -m "chore: add git-workflow config"
-```
-
-团队成员拉取代码后，自动使用统一的分支规范，同时保留各自的 AI commit 配置。
-
-</details>
-
-<details>
-<summary><b>场景三：强制关联 Issue/Story（适合团队协作）</b></summary>
-
-```json
-{
-  "requireId": true,
-  "featureIdLabel": "Jira ID",
-  "hotfixIdLabel": "Bug ID"
-}
-```
-
-**说明：**
-
-- `requireId: true` - 创建分支时必须填写 ID，不能跳过
-- 确保每个分支都能追溯到具体的需求或 Bug
-- 适合使用 Jira、禅道等项目管理工具的团队
-
-**效果对比：**
-
-```bash
-# requireId: false（默认）
-gw f
-? 请输入 Story ID (可跳过):        # 可以直接回车跳过
-? 请输入描述: add-login
-✔ 分支创建成功: feature/20260109-add-login
-
-# requireId: true
-gw f
-? 请输入 Jira ID:                  # 必须填写，不能跳过
-? 请输入描述: add-login
-✔ 分支创建成功: feature/20260109-PROJ-123-add-login
-```
-
-</details>
-
-<details>
-<summary><b>场景四：自动推送到远程（提高效率）</b></summary>
-
-```json
-{
-  "autoPush": true
-}
-```
-
-**说明：**
-
-- `autoPush: true` - 创建分支后自动推送到远程，不再询问
-- `autoPush: false` - 创建分支后不推送，不再询问
-- 不设置 - 每次创建分支时询问是否推送（默认行为）
-
-**效果对比：**
-
-```bash
-# autoPush 未设置（默认）
-gw f
-✔ 分支创建成功: feature/20260109-add-login
-? 是否推送到远程?                  # 每次都会询问
-  是
-  否
-
-# autoPush: true
-gw f
-✔ 分支创建成功: feature/20260109-add-login
-(自动推送已启用)                   # 直接推送，不询问
-✔ 已推送到远程: origin/feature/20260109-add-login
-
-# autoPush: false
-gw f
-✔ 分支创建成功: feature/20260109-add-login
-                                   # 不推送，不询问
-```
-
-**适用场景：**
-
-- `true` - 团队协作，需要及时同步分支
-- `false` - 个人开发，暂时不想推送
-- 不设置 - 灵活决定，根据情况选择
-
-</details>
-
-<details>
-<summary><b>场景五：基于 develop 分支开发</b></summary>
-
-```json
-{
-  "baseBranch": "develop",
-  "autoPush": true,
-  "requireId": true
-}
-```
-
-**说明：**
-
-- 所有新分支都基于 `develop` 创建
-- 自动推送到远程
-- 强制要求填写 ID
-
-</details>
-
-<details>
-<summary><b>场景六：自定义分支前缀</b></summary>
-
-```json
-{
-  "featurePrefix": "feat",
-  "hotfixPrefix": "fix"
-}
-```
-
-**说明：**
-
-- 分支名变为 `feat/20260109-xxx` 和 `fix/20260109-xxx`
-- 适合有特定命名规范的团队
-
-</details>
-
-<details>
-<summary><b>场景七：禁用 Emoji（适合严格的 CI/CD 环境）</b></summary>
-
-```json
-{
-  "useEmoji": false,
-  "autoStage": false
-}
-```
-
-**说明：**
-
-- 提交信息格式变为：`feat(scope): description` 而不是 `✨ feat(scope): description`
-- 手动选择要暂存的文件，而不是自动暂存所有更改
-
-</details>
-
-<details>
-<summary><b>场景八：自定义 Commit Emoji</b></summary>
-
-```json
-{
-  "commitEmojis": {
-    "feat": "🎉",
-    "fix": "🔧",
-    "docs": "📚",
-    "style": "🎨",
-    "refactor": "🔨",
-    "perf": "🚀",
-    "test": "🧪",
-    "build": "📦",
-    "ci": "👷",
-    "chore": "🔧",
-    "revert": "⏪"
-  }
-}
-```
-
-**说明：**
-
-- 可以只覆盖部分类型，未配置的使用默认 emoji
-
-</details>
-
-## 💡 最佳实践
-
-### 团队协作
-
-1. **统一配置** - 将 `.gwrc.json` 提交到仓库，确保团队使用相同的分支规范
-2. **强制 ID** - 开启 `requireId`，确保每个分支都能追溯到需求/Issue
-3. **自动推送** - 开启 `autoPush`，减少遗忘推送的情况
-4. **启用 AI Commit** - 配置 AI 提供商，让团队提交信息更规范统一
-
-### 版本发布
-
-1. **预发布测试** - 使用 alpha/beta/rc 版本进行测试
-2. **语义化版本** - 遵循 semver 规范：
-   - Bug 修复用 `patch`（1.0.0 → 1.0.1）
-   - 新功能用 `minor`（1.0.0 → 1.1.0）
-   - 破坏性变更用 `major`（1.0.0 → 2.0.0）
-3. **Tag 与版本同步** - 发布版本后立即创建对应的 tag
-
-### 分支清理
-
-1. **定期清理** - 使用 `gw d` 定期清理已合并的分支
-2. **远程同步** - 删除分支时同时清理远程分支
-3. **保持整洁** - 避免积累过多无用分支
-
-### Stash 管理
-
-1. **及时命名** - 创建 stash 时添加清晰的描述
-2. **定期清理** - 不再需要的 stash 及时删除
-3. **创建分支** - 对于长期保留的改动，考虑创建分支而不是 stash
-
-### Commit 规范
-
-1. **优先使用 AI** - AI 生成的 commit message 更规范、更准确
-2. **添加 scope** - 明确改动的模块或功能范围
-3. **关联 Issue** - 提交时关联相关的 Issue 编号
-4. **破坏性变更** - 重要的 API 变更要标记 BREAKING CHANGE
-
-## 🆚 与其他工具对比
-
-| 特性             | git-workflow  | git-flow    | 手动操作  |
-| ---------------- | ------------- | ----------- | --------- |
-| 学习成本         | ⭐ 极低       | ⭐⭐⭐ 较高 | ⭐⭐ 中等 |
-| 分支命名规范     | ✅ 自动生成   | ❌ 需手动   | ❌ 需手动 |
-| 版本号管理       | ✅ 智能递增   | ❌ 需手动   | ❌ 需手动 |
-| Tag 管理         | ✅ 完整支持   | ⚠️ 基础     | ❌ 需手动 |
-| AI Commit        | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
-| Stash 可视化管理 | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
-| 交互式操作       | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
-| 配置灵活性       | ✅ 项目级配置 | ⚠️ 有限     | -         |
-| 远程分支同步     | ✅ 自动处理   | ⚠️ 部分     | ❌ 需手动 |
-| 自动更新提醒     | ✅ 支持       | ❌ 不支持   | -         |
-
-## 🛠️ 开发
+### 快速开发
 
 ```bash
 # 克隆仓库
@@ -1147,38 +218,23 @@ npm install
 # 开发模式
 npm run dev
 
-# 构建
-npm run build
-
-# 本地测试
-npm link
-gw --version
-```
-
-## 📦 发布
+# 运行测试
+npm test
 
-```bash
-# 使用内置发布脚本（推荐）
-npm run publish:npm
-
-# 手动发布
+# 构建
 npm run build
-npm run changelog
-npm version patch  # 或 minor/major
-git push origin main --tags
-npm publish
 ```
 
 ## 🤝 贡献
 
-欢迎提交 Issue 和 Pull Request！
-
-在提交 PR 之前，请确保：
+欢迎提交 Issue 和 Pull Request！在提交 PR 之前，请确保：
 
 1. 代码通过 TypeScript 类型检查
 2. 遵循现有的代码风格
-3. 添加必要的注释和文档
-4. 测试你的更改
+3. 添加必要的测试用例
+4. 更新相关文档
+
+详细贡献指南请查看：[贡献指南](https://iamzjt-front-end.github.io/git-workflow/guide/contributing)
 
 ## 📄 License
 
@@ -1190,6 +246,10 @@ npm publish
 
 ---
 
+<p align="center">
+  <strong>📚 <a href="https://iamzjt-front-end.github.io/git-workflow/">完整文档</a> | 🚀 <a href="https://iamzjt-front-end.github.io/git-workflow/guide/getting-started">快速开始</a> | 📖 <a href="https://iamzjt-front-end.github.io/git-workflow/commands/">命令参考</a> | ⚙️ <a href="https://iamzjt-front-end.github.io/git-workflow/config/">配置指南</a></strong>
+</p>
+
 <p align="center">
   <strong>如果这个工具对你有帮助，请给个 ⭐️ 支持一下！</strong>
 </p>
@@ -1197,5 +257,6 @@ npm publish
 <p align="center">
   <a href="https://github.com/iamzjt-front-end/git-workflow">GitHub</a> •
   <a href="https://www.npmjs.com/package/@zjex/git-workflow">npm</a> •
-  <a href="https://github.com/iamzjt-front-end/git-workflow/issues">Issues</a>
+  <a href="https://github.com/iamzjt-front-end/git-workflow/issues">Issues</a> •
+  <a href="https://iamzjt-front-end.github.io/git-workflow/">文档</a>
 </p>