# flu-cli
**Repository Path**: 616800976/flu-cli
## Basic Information
- **Project Name**: flu-cli
- **Description**: 让 Flutter 研发像呼吸一样顺畅
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-06-17
- **Last Updated**: 2026-06-17
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Flu-CLI
**让 Flutter 研发像呼吸一样顺畅**
[](https://www.npmjs.com/package/flu-cli)
[](https://www.npmjs.com/package/flu-cli-core)
[](https://marketplace.visualstudio.com/items?itemName=huoye-studio.flu-cli-vscode)
[](./LICENSE)
[文档](https://huozhiye.cn/flu-cli) | [快速开始](#-快速开始) | [VSCode 扩展](#-vscode-扩展) | [插件分发系统](#-多平台分发)
---
## 📖 项目简介
Flu-CLI 是一个专为 Flutter 开发设计的全流程效率工具链，覆盖项目创建、代码生成、资源管理、团队规范到多平台构建发布的完整闭环。本仓库采用 **Monorepo** 架构，统一管理 CLI 工具、核心逻辑库、独立上传库、VSCode 扩展。
### ✨ 核心特性
#### 📦 项目创建与开发
- **多模板支持** — Lite(轻量)、Modular(模块化)、Clean(整洁架构)、Native 标准模板
- **自定义模板** — 支持使用 Git 仓库或本地目录作为项目模板
- **智能网络层** — 创建项目时可选择是否包含网络层(Dio + 示例代码)，按需引入
- **快速代码生成** — Page、Widget、Component、ViewModel、Service、Model、Module
- **快捷键支持** — `Cmd+Shift+G` (Mac) / `Ctrl+Shift+G` (Win) 快速生成
- **资源管理** — 一张 1024 图自动适配全平台 App 图标和启动图
#### 🚀 插件式分发系统 (Plugin-based Distribution System)
- **自动化构建** — Android APK/AAB、iOS IPA 一键构建
- **多平台对接** — 基于官方开放 API，支持华为、小米、OPPO、vivo、App Store、鸿蒙等主流平台
- **三种使用方式** — VSCode 插件 (GUI) / CLI 命令行 / npm 核心库
- **不限框架** — Flutter、React Native、原生 Android/iOS、鸿蒙，有安装包就能传
- **发布中心** — VSCode 可视化发布管理界面，实时查看构建和上传进度
---
## 📁 项目结构
```
flu-cli/
├── packages/
│ ├── core/ # 🧠 核心逻辑库（代码生成器、模板引擎、构建器）
│ ├── cli/ # ⌨️ CLI（核心命令行工具）
│ ├── vscode-extension/ # 🖥️ VSCode 扩展（发布中心 + 代码生成）
│ └── app-ship/ # 🚀 独立发布引擎 (核心开发模式可见，已关联独立仓库)
│
├── .agent/ # 🤖 AI Agent 技能与上下文
├── README.md # 项目主说明
├── CONTRIBUTING.md # 贡献指南
└── CHANGELOG.md # 版本更新日志
```
### 包说明
| 包 | 说明 | 状态 |
| ------------------------------------------------------------ | ----------------------------------------- | ----------- |
| **[packages/core](./packages/core)** | 核心逻辑库 — 代码生成、模板引擎、构建器 | 📦 库 |
| **[packages/cli](./packages/cli)** | CLI — 项目创建、代码生成、资源管理 | ✅ 主要版本 |
| **[packages/vscode-extension](./packages/vscode-extension)** | VSCode 扩展 — 可视化发布中心 + 全功能 GUI | ✅ 已发布 |
```mermaid
graph TB
subgraph "Monorepo 架构"
CLI[packages/cli
CLI 工具
活跃开发]
Core[packages/core
核心逻辑库
TypeScript]
VSCode[packages/vscode-extension
VSCode 扩展
已发布]
end
subgraph "模板仓库"
TL[template_lite]
TM[template_modular]
TC[template_clean]
end
CLI --> Core
VSCode --> Core
CLI -.->|使用| TL
CLI -.->|使用| TM
CLI -.->|使用| TC
style CLI fill:#4CAF50,stroke:#388E3C,stroke-width:2px
style Core fill:#2196F3,stroke:#1976D2,stroke-width:2px
style VSCode fill:#FF9800,stroke:#F57C00,stroke-width:2px
```
---
## 🚀 快速开始
### 方式一：VSCode 扩展（推荐）
直接在 VSCode 插件市场搜索 `Flu CLI` 并安装，即可享受可视化操作体验。
👉 [点击安装 VSCode 插件](https://marketplace.visualstudio.com/items?itemName=huoye-studio.flu-cli-vscode)
### 方式二：命令行 (CLI)
```bash
# 安装
npm install -g flu-cli
# 创建项目
flu new my_app
# 添加页面
flu add page home
# 添加 Service / Model
flu add service api
flu add model user
# 资源管理（图标 + 启动图）
flu assets
```
---
## 📤 多平台分发 (Technical Compliance)
本项目基于**官方开放 API**实现应用分发功能。所有接口调用均严格遵守平台方开发者协议，仅用于辅助开发者提高分发效率。
### 官方 API 引用 (Official References)
为了确保操作的合规性与安全性，建议查阅各平台官方 API 文档：
- **Huawei**: [AppGallery Connect API](https://developer.huawei.com/consumer/cn/doc/development/AppGallery-connect-References/agcapi-overview-0000001158245051)
- **Xiaomi**: [应用推送接口](https://dev.mi.com/distribute/doc/details?pId=1097)
- **OPPO**: [应用传包接口](https://open.oppomobile.com/wiki/doc#id=10734)
- **vivo**: [应用传包能力](https://dev.vivo.com.cn/documentCenter/doc/318)
- **Apple**: [App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi)
- **Harmony**: [AGC API 业务介绍](https://developer.huawei.com/consumer/cn/doc/development/AppGallery-connect-Guides/agc-get-started-0000001058240759)
- **Pgyer**: [蒲公英 API V2](https://www.pgyer.com/doc/view/api#uploadApp)
更多详情请查阅 [官方文档](https://huozhiye.cn/flu-cli)。
---
## 🎨 VSCode 扩展
Flu CLI VSCode 扩展将 CLI 的强大能力无缝集成到 VSCode 中。
### 主要功能
- **可视化创建项目** — 向导式创建 Lite/Modular/Clean 或自定义模板项目
- **快捷键加速** — `Cmd+Shift+G` (Mac) / `Ctrl+Shift+G` (Win) 快速唤起生成面板
- **右键生成文件** — 在目录树右键即可生成 Page、Widget、Model 等
- **资源管理可视化** — 图形界面配置 App Icon 和启动图
- **发布中心** — 一体化的打包上传管理界面，8 平台并行上传
- **智能感知** — 动态 Snippets，根据架构上下文提供代码补全
### 获取扩展
- [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=huoye-studio.flu-cli-vscode)
---
## 🛠️ 开发指南
### 环境要求
- Node.js >= 16.0.0
- npm
- Git
### 启动项目
```bash
# 1. 克隆仓库
git clone https://gitee.com/flu-cli/flu-cli.git
cd flu-cli
# 2. 安装依赖
npm install
# 3. 构建核心库
npm run build:core
# 4. 调试 VSCode 插件 (推荐)
# ✅ 核心步骤：
# - 方式 A (命令行构建产物): npm run vs
# - 方式 B (VSCode F5 调试): 在 VSCode 中按 F5 键，选择 "VSCode Extension (Dev)"。
# (提示：F5 调试会自动触发 build:watch，无需手动运行构建命令)
# 🚦 调试建议：
# - 如果你是普通开发者：直接按 F5 即可开始调试插件。
# - 如果你修改了本地 app-ship 源码：建议先运行一次 `npm run vs` 确保内联同步，再按 F5。
# 5. 开发 CLI
npm run dev:cli
# 6. 开发 VSCode 扩展 Webview
npm run dev:vscode
```
更多开发细节请参考 [CONTRIBUTING.md](./CONTRIBUTING.md)。
---
## 📚 相关资源
- 📖 [在线文档](http://huozhiye.cn/flu-cli)
- 📦 [分发模块](https://huozhiye.cn/flu-cli) — 插件式上传集成
- 🗺️ [路线图与待办](./.agent/ROADMAP.md) — 规划中工作与检查清单（仓库内唯一维护入口）
- 📎 [产品文档索引](./documentation/README.md) — `.flu-cli.json`、AI Manifest、技术架构说明（面向终端用户能力）
- 🤝 [贡献指南](./CONTRIBUTING.md)
- 📋 [更新日志](./CHANGELOG.md)
### 模板仓库
- [template_lite](https://gitee.com/flu-cli/template_lite)
- [template_modular](https://gitee.com/flu-cli/template_modular)
- [template_clean](https://gitee.com/flu-cli/template_clean)
### 问题反馈
- [Gitee Issues](https://gitee.com/flu-cli/flu-cli/issues)
- 公众号「火叶」回复 "flu" 加入开发者交流群
---
## 📄 许可证
[MIT License](./LICENSE) - Copyright © 2026 火叶工作室
---
**如果这个项目对你有帮助，请给个 ⭐️ Star！**
Made with ❤️ by 火叶工作室