@iflow-ai/iflow-cli 0.1.2 → 0.1.4

package/README.md

@@ -1,5 +1,4 @@
 # 🤖 iFlow CLI
-![iFlow CLI Screenshot](./assets/iflow-cli.jpg)
 
 **English** | [中文](README_CN.md) | [日本語](README_JA.md) | [한국어](README_KO.md) | [Français](README_FR.md) | [Deutsch](README_DE.md) | [Español](README_ES.md) | [Русский](README_RU.md)
 
@@ -15,6 +14,7 @@ iFlow CLI is a powerful AI assistant that runs directly in your terminal. It sea
 ## 📥 Installation
 
 ### System requirements
+
 - Operating Systems: macOS 10.15+, Ubuntu 20.04+/Debian 10+, or Windows 10+ (with WSL 1, WSL 2, or Git for Windows)
 - Hardware: 4GB+ RAM
 - Software: Node.js 18+
@@ -22,13 +22,31 @@ iFlow CLI is a powerful AI assistant that runs directly in your terminal. It sea
 - Shell: Works best in Bash, Zsh or Fish
 
 ### install command
+
 ```shell
 bash -c "$(curl -fsSL https://cloud.iflow.cn/iflow-cli/install.sh)"
 ```
 
 This command automatically installs all necessary dependencies for your terminal.
 
-**Windows Users**: First launch `bash` in your terminal, then run the installation script above.
+**Windows Users**:
+
+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
+
+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
+2. Run the installer to install nvm
+3. **Restart your terminal: CMD or PowerShell**
+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
 
 ## 🔑 Authentication
 
@@ -40,6 +58,7 @@ iFlow offers two authentication options:
 ![iFlow CLI Login](./assets/login.jpg)
 
 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
@@ -135,20 +154,35 @@ iFlow CLI extends beyond coding to handle a wide range of tasks:
 > Write a program that downloads stock prices daily and sends me email notifications.
 ```
 
-*Note: Advanced automation tasks can leverage MCP servers to integrate your local system tools with enterprise collaboration suites.*
+_Note: Advanced automation tasks can leverage MCP servers to integrate your local system tools with enterprise collaboration suites._
 
 ## 🔧 Switch to customized model
 
 iFlow CLI can connect to any OpenAI-compatible API. Edit the settings file in `~/.iflow/settings.json` to change the model you use.
 
 Here is a settings demo file:
+
 ```json
 {
-    "theme": "Default",
-    "selectedAuthType": "iflow",
-    "apiKey": "your iflow key",
-    "baseUrl": "https://apis.iflow.cn/v1",
-    "modelName": "Qwen3-Coder",
-    "searchApiKey": "your iflow key"
+  "theme": "Default",
+  "selectedAuthType": "iflow",
+  "apiKey": "your iflow key",
+  "baseUrl": "https://apis.iflow.cn/v1",
+  "modelName": "Qwen3-Coder",
+  "searchApiKey": "your iflow key"
 }
-```
+```
+
+## GitHub Actions
+
+You can also use iFlow CLI in your GitHub Actions workflows with the community-maintained action: [iflow-cli-action](https://github.com/vibe-ideas/iflow-cli-action)
+
+## Community Communication
+
+If you encounter problems in use, you can directly raise Issues on the github page.
+
+You can also scan the following Wechat group to join the community group for communication and discussion.
+
+### Wechat group
+
+![Wechat group](./assets/iflow-wechat.jpg)