iflow-comm 1.0.0 → 1.0.2

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,59 @@
+name: Bug Report
+description: Report a bug to help us improve iFlow CLI
+labels: ['kind/bug', 'status/need-triage']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!CAUTION]
+        > iFlow CLI is shutting down on April 17, 2026 (UTC+8). No new features or bug fixes will be released.
+        > See our [farewell post](https://vibex.iflow.cn/t/topic/4819) for details.
+
+        > [!IMPORTANT]
+        > Thanks for taking the time to fill out this bug report!
+        >
+        > Please search **[existing issues](https://github.com/iflow-ai/iflow-cli/issues)** to see if an issue already exists for the bug you encountered.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What happened?
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: info
+    attributes:
+      label: Client information
+      description: Please paste the full text from the `/about` command run from iFLow CLI. Also include which platform (macOS, Windows, Linux).
+      value: |
+        <details>
+
+        ```console
+        $ iflow /about
+        # paste output here
+        ```
+
+        </details>
+    validations:
+      required: true
+
+  - type: textarea
+    id: login-info
+    attributes:
+      label: Login information
+      description: Describe how you are logging in (e.g., iFlow Account, API key).
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Anything else we need to know?
+      description: Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,37 @@
+name: Feature Request
+description: Suggest an idea for this project
+labels: ['kind/enhancement', 'status/need-triage']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!CAUTION]
+        > iFlow CLI is shutting down on April 17, 2026 (UTC+8). No new features or bug fixes will be released.
+        > See our [farewell post](https://vibex.iflow.cn/t/topic/4819) for details.
+
+        > [!IMPORTANT]
+        > Thanks for taking the time to suggest an enhancement!
+        >
+        > Please search **[existing issues](https://github.com/iflow-ai/iflow-cli/issues)** to see if a similar feature has already been requested.
+
+  - type: textarea
+    id: feature
+    attributes:
+      label: What would you like to be added?
+      description: A clear and concise description of the enhancement.
+    validations:
+      required: true
+
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Why is this needed?
+      description: A clear and concise description of why this enhancement is needed.
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

package/IFLOW.md

@@ -0,0 +1,384 @@
+# IFLOW.md
+
+此文件为 iFlow CLI 提供项目指导信息，帮助 AI 助手更好地理解和协作开发。
+
+## 项目概述
+
+iFlow CLI 是一款直接在终端运行的强大 AI 助手，能够无缝分析代码仓库、执行编程任务、理解上下文需求，并通过自动化处理从简单的文件操作到复杂的工作流程，全面提升您的工作效率。
+
+本项目是 iFlow CLI 的官方仓库，包含安装脚本、多语言文档、资源文件和配置示例。
+
+## 核心特性
+
+1. **免费 AI 模型**：通过心流开放平台访问强大的免费 AI 模型，包括 Kimi K2、Qwen3 Coder、DeepSeek v3 等
+2. **灵活集成**：兼容 OpenAI 协议的模型提供商，支持切换使用 Claude、ChatGPT 等模型
+3. **工作流系统**：整合 agents、commands、MCP 工具创建完整的自动化工作流程
+4. **Hook 系统**：支持 9 种 Hook 类型，在特定事件发生时自动执行自定义命令
+5. **多模态支持**：支持图片粘贴理解，识别手稿并产出代码
+6. **IDE 集成**：支持 VS Code、JetBrains、Zed (ACP 协议) 查看和交互
+7. **对话管理**：支持历史对话保存、恢复和回滚（`iflow --resume`、`/chat` 命令）
+8. **心流开放市场**：一键安装 Sub Agent、MCP、Command、Workflow，所有组件均经过安全认证
+9. **国际化支持**：支持中文、英文、日文、韩文、法文、德文、西班牙文、俄文
+10. **自动升级**：自动检测最新版本并提示更新
+
+## 仓库结构
+
+- `install.sh` / `install_beta.sh` - 安装脚本
+- `README*.md` - 多语言文档（中文、英文、日文、韩文、法文、德文、西班牙文、俄文）
+- `assets/` - 图片和截图
+- `docs_cn/` - 中文文档
+  - `quickstart.md` - 快速开始指南
+  - `changelog.md` - 版本变更历史
+  - `glossary.md` - 术语词汇表
+  - `scenarios.md` - 使用场景
+  - `configuration/` - 配置相关文档
+  - `examples/` - 使用示例
+  - `features/` - 功能详解
+  - `sdk/` - SDK 文档
+- `docs_en/` - 英文文档（结构同上）
+- `Formula/` - Homebrew 安装配方
+- `.github/` - GitHub 配置和 Issue 模板
+
+## 安装方法
+
+### 系统要求
+- 操作系统：macOS 10.15+、Ubuntu 20.04+/Debian 10+，或 Windows 10+（使用 WSL 1、WSL 2 或 Git for Windows）
+- 硬件：4GB+ 内存
+- 软件：Node.js 22+
+- 网络：需要互联网连接用于身份验证和 AI 处理
+
+### 快速安装
+
+**macOS/Linux**
+```bash
+# Homebrew 安装
+brew tap iflow-ai/iflow-cli
+brew install iflow-cli
+
+# 一键安装脚本
+bash -c "$(curl -fsSL https://gitee.com/iflow-ai/iflow-cli/raw/main/install.sh)"
+
+# 使用 npm 安装
+npm i -g iflow-comm@latest
+```
+
+**Windows**
+```bash
+# 1. 访问 https://nodejs.org/zh-cn/download 下载最新的 Node.js 安装程序
+# 2. 运行安装程序安装 Node.js
+# 3. 重启终端：CMD 或 PowerShell
+# 4. 运行以下命令安装
+npm install -g iflow-comm@latest
+# 5. 运行 iflow-comm 启动
+```
+
+### 验证安装
+```bash
+iflow-comm --version
+```
+
+### 卸载
+```bash
+npm uninstall -g iflow-comm
+```
+
+## 身份验证
+
+iFlow CLI 支持三种身份验证方式：
+
+1. **Login with iFlow（推荐）**：通过心流平台网页授权，享受完整功能（WebSearch、WebFetch、多模态、工具调用优化），令牌自动续期
+2. **心流 API Key**：适用于服务器环境，功能与第一种相同，但 API Key 有效期为 7 天
+3. **OpenAI Compatible API**：使用自有模型服务，不支持心流平台的 WebSearch、WebFetch 和多模态功能
+
+## 核心功能
+
+### 工作流系统
+- 整合 agents、commands、MCP 工具创建完整的自动化工作流程
+- 心流开放平台预置大量优秀工作流（小红书发文、深度研究、PPT 制作、流程图绘制等）
+- 支持开发者工作流（GitHub spec、bmad、NioPD、ai-dev-task 等）
+- 工作流默认安装在项目级别
+
+### Hook 系统
+支持 9 种 Hook 类型：
+- **PreToolUse** - 工具执行前触发
+- **PostToolUse** - 工具执行后触发
+- **SetUpEnvironment** - 会话开始时环境设置
+- **Stop** - 主会话结束时触发
+- **SubagentStop** - 子代理会话结束时触发
+- **SessionStart** - 会话开始时触发
+- **SessionEnd** - 会话结束时触发
+- **UserPromptSubmit** - 用户提交提示词前触发
+- **Notification** - 发送通知时触发
+
+### 运行模式
+支持 4 种运行模式：
+- **YOLO 模式** - 模型拥有最大权限，可执行任何操作
+- **接受编辑模式** - 模型仅拥有文件修改权限
+- **计划模式** - 先计划后执行
+- **默认模式** - 模型无权限
+
+### 多模态支持
+- 支持图片粘贴理解（Ctrl+V）
+- 识别手稿并产出代码
+- 支持读取 doc、excel、pdf 文件
+
+### IDE 集成
+- **VS Code** - 自动安装插件
+- **JetBrains** - 支持连接
+- **Zed** - 支持 ACP 协议
+
+### 对话管理
+- `iflow-comm --resume` - 恢复历史对话
+- `iflow-comm --continue` - 继续上次对话
+- `/chat` - 保存、恢复、删除对话检查点
+
+### 心流开放市场
+- 一键安装 MCP 工具
+- 一键安装 Sub Agent
+- 一键安装自定义命令
+- 一键安装工作流
+- 所有组件均经过安全认证
+
+## 关键斜杠命令
+
+### 系统管理
+- `/about` - 显示系统信息（版本、操作系统、模型版本等）
+- `/auth` - 配置或更改身份验证提供商
+- `/theme` - 自定义 CLI 外观主题
+- `/model` - 更改正在使用的 AI 模型
+- `/editor` - 配置首选的外部编辑器
+- `/privacy` - 显示隐私通知和数据处理信息
+- `/language` - 切换中英文界面
+
+### 会话控制
+- `/chat` - 保存、恢复、删除对话检查点
+- `/clear` - 清除屏幕并重置对话历史
+- `/compress` - 使用 AI 将对话历史压缩为摘要
+- `/memory` - 与 CLI 的内容系统交互
+- `/restore` - 恢复到之前的检查点状态
+- `/quit` - 退出 CLI 会话并显示统计信息
+
+### 工具集成
+- `/ide` - 发现和连接到可用的 IDE 服务器
+- `/ide-status` - 查询当前 IDE 连接状态
+- `/ide-tool` - 访问特定的 IDE 集成工具
+- `/mcp` - 管理 MCP 服务器、工具和身份验证
+- `/tools` - 列出所有可用的内置 CLI 工具
+- `/extensions` - 显示当前活动的扩展及版本
+
+### 开发辅助
+- `/init` - 分析项目并创建定制的配置文件
+- `/setup-github` - 配置 GitHub Actions 工作流
+- `/directory` - 管理工作空间目录以获得项目上下文
+- `/export` - 以各种格式导出对话历史
+- `/copy` - 将最后的 AI 响应复制到剪贴板
+
+### 监控调试
+- `/stats` - 监控会话使用情况和性能统计
+- `/log` - 显示当前会话日志存储位置
+- `/bug` - 提交带有系统信息的错误报告
+- `/help` - 打开综合帮助对话框
+- `/docs` - 在浏览器中打开完整文档
+
+### 特殊功能
+- `/vim` - 切换 vim 风格按键绑定
+- `/corgi` - 切换柯基主题 UI 模式（彩蛋）
+- `/commands` - 管理和安装自定义命令
+- `/agents` - 管理个人、项目和内置代理
+- `/demo` - 交互式演示功能
+- `/resume` - 恢复历史对话
+
+## @ 命令（文件引用）
+
+使用 `@` 符号引用文件或目录内容：
+- `@<path_to_file_or_directory>` - 将文件或目录内容注入到提示中
+- 支持自动补全和递归搜索
+
+## Shell 模式（!）
+
+使用 `!` 符号执行系统 shell 命令：
+- `!<shell_command>` - 执行 shell 命令
+- `!` - 切换 shell 模式
+
+## Sub Agent 系统
+
+使用 `$` 符号快速调用专业化 Agent：
+- `$<agent-type> <task_description>` - 直接在当前对话中执行专业任务
+- 支持的 Agent 类型：general-purpose、code-reviewer、frontend-developer、python-expert、data-scientist、doc-writer 等
+- 支持通过心流开放市场安装更多 Agent
+
+## 配置文件
+
+iFlow CLI 支持分层配置系统：
+
+### 配置层级（优先级从高到低）
+1. 命令行参数
+2. IFLOW 前缀环境变量
+3. 系统配置文件（`/etc/iflow-cli/settings.json` 或类似路径）
+4. 工作区配置文件（`./.iflow/settings.json`）
+5. 用户配置文件（`~/.iflow/settings.json`）
+6. 默认值
+
+### 环境变量支持
+所有 `settings.json` 中的配置项都可以通过环境变量设置，使用 `IFLOW_` 前缀：
+- `IFLOW_apiKey` - API 密钥
+- `IFLOW_baseUrl` - 基础 URL
+- `IFLOW_modelName` - 模型名称
+- `IFLOW_theme` - 主题设置
+- 等等
+
+### 配置示例
+```json
+{
+  "selectedAuthType": "iflow",
+  "apiKey": "your_api_key",
+  "baseUrl": "https://apis.iflow.cn/v1",
+  "modelName": "Qwen3-Coder",
+  "theme": "Default",
+  "hooks": {
+    "PreToolUse": [
+      {
+        "matcher": "Edit|Write",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "echo 'File operation detected'"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+## 文档结构
+
+详细的文档位于 `docs_cn/` 和 `docs_en/` 目录：
+
+- **quickstart.md** - 5 分钟快速开始指南
+- **changelog.md** - 版本更新历史
+- **glossary.md** - 术语词汇表
+- **scenarios.md** - 使用场景示例
+- **configuration/** - 详细配置说明
+  - iflow.md - IFLOW.md 配置说明
+  - iflowignore.md - .iflowignore 配置
+  - settings.md - settings.json 完整配置
+- **examples/** - 使用示例
+  - basic-usage.md - 基础用法
+  - best-practices.md - 最佳实践
+  - mcp.md - MCP 扩展系统
+  - subagent.md - Sub Agent 使用
+  - subcommand.md - 自定义命令
+  - workflow.md - 工作流系统
+  - hooks.md - Hook 配置
+  - keyboard-shortcuts.md - 键盘快捷键
+- **features/** - 功能详解
+  - slash-commands.md - 斜杠命令详解
+  - interactive.md - 交互模式
+  - ide.md - IDE 集成
+  - checkpointing.md - 检查点功能
+  - suspending-resuming.md - 暂停和恢复
+  - telemetry.md - 遥测功能
+  - thinking.md - 思考模式
+  - output-style.md - 输出样式
+  - sandbox.md - 沙箱模式
+  - action.md - Action 功能
+  - memory-import.md - 记忆导入
+- **sdk/** - SDK 文档
+  - sdk-python.md - Python SDK
+  - sdk-android.md - Android SDK
+
+## 架构概览
+
+iFlow CLI 是基于 Node.js 构建的命令行工具，集成了多个 AI 模型和 MCP 服务器，提供强大的终端 AI 助手能力。
+
+### 核心组件
+- **CLI 界面** - 基于 Terminal UI 的交互式界面
+- **模型集成** - 支持心流平台和 OpenAI 协议的多种 AI 模型
+- **MCP 客户端** - 用于连接和管理 MCP 服务器
+- **Sub Agent 系统** - 智能任务分发和专业化处理
+- **Hook 系统** - 事件驱动的自动化执行
+- **工作流引擎** - 组件编排和自动化流程
+- **IDE 集成** - VS Code、JetBrains、Zed 插件支持
+
+### 安装脚本功能
+1. 检测并安装 Node.js（如果未安装）
+2. 设置 npm 全局目录
+3. 安装 iFlow CLI 包
+4. 配置 MCP 服务器（如需要）
+5. 初始化用户配置
+
+### 多语言支持
+- 通过 `docs_cn/` 和 `docs_en/` 目录提供完整的中文和英文文档
+- CLI 界面支持中英文切换（`/language` 命令）
+- 自动检测终端语言设置
+
+## 常见使用场景
+
+### 项目初始化
+```bash
+cd your-project/
+iflow-comm
+> /init
+> 分析项目结构并创建 IFLOW.md
+```
+
+### 代码开发
+```bash
+iflow-comm
+> 创建一个 React 组件，实现用户登录功能
+```
+
+### 代码审查
+```bash
+iflow-comm
+> $code-reviewer 对当前项目进行全面的代码审查
+```
+
+### 数据分析
+```bash
+iflow-comm
+> 分析 sales_data.csv 中的销售趋势，生成可视化图表
+```
+
+### 工作流使用
+```bash
+# 安装 PPT 生成工作流
+iflow workflow add "ppt-generator-v3-OzctqA"
+
+# 使用工作流
+iflow-comm
+> /ppt-generator
+```
+
+## 故障排除
+
+### 安装问题
+```bash
+# 检查 Node.js 版本
+node --version  # 需要 22+
+
+# 检查网络连接
+curl -I https://apis.iflow.cn/v1
+```
+
+### 认证问题
+- 确保使用正确的认证方式
+- 检查 API 密钥或令牌是否有效
+- 验证网络连接是否正常
+
+### 命令不响应
+- 使用 `Ctrl+C` 中断当前操作
+- 运行 `/clear` 清空上下文
+- 重启 CLI：`/quit` 后重新运行 `iflow-comm`
+
+## 社区和支持
+
+- **GitHub Issues**：[提交问题](https://github.com/iflow-ai/iflow-cli/issues)
+- **心流开放平台**：[https://platform.iflow.cn/](https://platform.iflow.cn/)
+- **文档中心**：[https://platform.iflow.cn/docs](https://platform.iflow.cn/docs)
+
+## 版本信息
+
+当前版本信息请使用 `iflow-comm --version` 或 `/about` 命令查看。
+详细的版本更新历史请参考 `docs_cn/changelog.md` 或 `docs_en/changelog.md`。

package/README.md

@@ -81,7 +81,7 @@ brew install iflow-cli
 
 * Using Node.js installation
 ```shell
-npm i -g @iflow-ai/iflow-cli
+npm i -g iflow-comm
 ```
 
 This command automatically installs all necessary dependencies for your terminal.
@@ -90,8 +90,8 @@ This command automatically installs all necessary dependencies for your terminal
 1. Go to https://nodejs.org/en/download to download the latest Node.js installer
 2. Run the installer to install Node.js
 3. Restart your terminal: CMD or PowerShell
-4. Run `npm install -g @iflow-ai/iflow-cli` to install iFlow CLI
-5. Run `iflow` to start iFlow CLI
+4. Run `npm install -g iflow-comm` to install iFlow CLI
+5. Run `iflow-comm` to start iFlow CLI
 
 If you are in China Mainland, you can use the following command to install iFlow CLI:
 1. Go to https://cloud.iflow.cn/iflow-cli/nvm-setup.exe to download the latest nvm installer
@@ -100,44 +100,44 @@ If you are in China Mainland, you can use the following command to install iFlow
 4. Run `nvm node_mirror https://npmmirror.com/mirrors/node/` and `nvm npm_mirror https://npmmirror.com/mirrors/npm/`
 5. Run `nvm install 22` to install Node.js 22
 6. Run `nvm use 22` to use Node.js 22
-7. Run `npm install -g @iflow-ai/iflow-cli` to install iFlow CLI
-8. Run `iflow` to start iFlow CLI
+7. Run `npm install -g iflow-comm` to install iFlow CLI
+8. Run `iflow-comm` to start iFlow CLI
 
 ## 🗑️ Uninstall
 ```shell
-npm uninstall -g @iflow-ai/iflow-cli
+npm uninstall -g iflow-comm
 ```
 
 ## 🔑 Authentication
 
-iFlow CLI supports OpenAI-compatible APIs for authentication and model access.
+iFlow offers two authentication options:
 
-To configure your API credentials, edit the settings file in `~/.iflow/settings.json`:
+1. **Recommended**: Use iFlow's native authentication
+2. **Alternative**: Connect via OpenAI-compatible APIs
 
-```json
-{
-    "selectedAuthType": "openai-compatible",
-    "apiKey": "your_api_key",
-    "baseUrl": "https://api.openai.com/v1",
-    "modelName": "gpt-4"
-}
-```
+![iFlow CLI Login](./assets/login.jpg)
 
-You can also set these values using environment variables:
+Choose option 1 to login directly, which will open iFlow account authentication in a web page. After completing authentication, you can use it for free.
 
-```bash
-export IFLOW_apiKey="your_api_key"
-export IFLOW_baseUrl="https://api.openai.com/v1"
-export IFLOW_modelName="gpt-4"
-iflow
-```
+![iFlow CLI Web Login](./assets/web-login.jpg)
+
+If you are in an environment like a server where you cannot open a web page, please use option 2 to login.
+
+To get your API key:
+1. Register for an iFlow account
+2. Go to your profile settings or click [this direct link](https://iflow.cn/?open=setting)
+3. Click "Reset" in the pop-up dialog to generate a new API key
+
+![iFlow Profile Settings](./assets/profile-settings.jpg)
+
+After generating your key, paste it into the terminal prompt to complete setup.
 
 ## 🚀 Getting Started
 
 To launch iFlow CLI, navigate to your workspace in the terminal and type:
 
 ```shell
-iflow
+iflow-comm
 ```
 
 ### Starting New Projects
@@ -146,7 +146,7 @@ For new projects, simply describe what you want to create:
 
 ```shell
 cd new-project/
-iflow
+iflow-comm
 > Create a web-based Minecraft game using HTML
 ```
 
@@ -156,7 +156,7 @@ For existing codebases, begin with the `/init` command to help iFlow understand
 
 ```shell
 cd project1/
-iflow
+iflow-comm
 > /init
 > Analyze the requirements according to the PRD document in requirement.md file, and output a technical document, then implement the solution.
 ```
@@ -229,10 +229,11 @@ Here is a settings demo file:
 ```json
 {
     "theme": "Default",
-    "selectedAuthType": "openai-compatible",
-    "apiKey": "your_api_key",
-    "baseUrl": "https://api.openai.com/v1",
-    "modelName": "gpt-4"
+    "selectedAuthType": "iflow",
+    "apiKey": "your iflow key",
+    "baseUrl": "https://apis.iflow.cn/v1",
+    "modelName": "Qwen3-Coder",
+    "searchApiKey": "your iflow key"
 }
 ```