docs(readme): refresh plugin badge layout and mirrors
- update plugin README badge rows and mirrored docs - sync README template and scaffolder guidance Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
39
docs/plugins/pipes/iflow-sdk-pipe.md
Normal file
39
docs/plugins/pipes/iflow-sdk-pipe.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# iFlow Official SDK Pipe
|
||||
|
||||
This plugin integrates the [iFlow SDK](https://platform.iflow.cn/cli/sdk/sdk-python) into OpenWebUI as a `Pipe`.
|
||||
|
||||
## Features
|
||||
|
||||
- **Standard iFlow Integration**: Connects to the iFlow CLI process via WebSocket (ACP).
|
||||
- **Auto-Process Management**: Automatically starts the iFlow process if it's not running.
|
||||
- **Streaming Support**: Direct streaming from iFlow to the chat interface.
|
||||
- **Status Updates**: Real-time status updates in the UI (thinking, tool usage, etc.).
|
||||
- **Tool Execution Visibility**: See when iFlow is calling and completing tools.
|
||||
|
||||
## Configuration
|
||||
|
||||
Set the following `Valves`:
|
||||
|
||||
- `IFLOW_PORT`: The port for the iFlow CLI process (default: `8090`).
|
||||
- `IFLOW_URL`: The WebSocket URL (default: `ws://localhost:8090/acp`).
|
||||
- `AUTO_START`: Automatically start the process (default: `True`).
|
||||
- `TIMEOUT`: Request timeout in seconds.
|
||||
- `LOG_LEVEL`: SDK logging level (DEBUG, INFO, etc.).
|
||||
|
||||
## Installation
|
||||
|
||||
This plugin requires both the **iFlow CLI** binary and the **iflow-cli-sdk** Python package.
|
||||
|
||||
### 1. Install iFlow CLI (System level)
|
||||
|
||||
Run the following command in your terminal (Linux/macOS):
|
||||
|
||||
```bash
|
||||
bash -c "$(curl -fsSL https://platform.iflow.cn/cli/install.sh)"
|
||||
```
|
||||
|
||||
### 2. Install Python SDK (OpenWebUI environment)
|
||||
|
||||
```bash
|
||||
pip install iflow-cli-sdk
|
||||
```
|
||||
Reference in New Issue
Block a user