refactor: rename skill to higress-openclaw-integration and update model configs (#3475)

2026-06-24 09:45:16 +08:00 · 2026-02-12 14:02:29 +08:00
parent 1f10cc293f
commit e9bb5d3255
10 changed files with 100 additions and 109 deletions
--- a/.claude/skills/higress-openclaw-integration/SKILL.md
+++ b/.claude/skills/higress-openclaw-integration/SKILL.md
@@ -0,0 +1,417 @@
+---
+name: higress-openclaw-integration
+description: "Deploy and configure Higress AI Gateway for OpenClaw integration. Use when: (1) User wants to deploy Higress AI Gateway, (2) User wants to configure OpenClaw to use Higress as a model provider, (3) User mentions 'higress', 'ai gateway', 'model gateway', 'AI网关', (4) User wants to set up model routing or auto-routing, (5) User needs to manage LLM provider API keys."
+---
+
+# Higress AI Gateway Integration
+
+Deploy and configure Higress AI Gateway for OpenClaw integration with one-click deployment, model provider configuration, and auto-routing.
+
+## Prerequisites
+
+- Docker installed and running
+- Internet access to download setup script
+- LLM provider API keys (at least one)
+
+## Workflow
+
+### Step 1: Download Setup Script
+
+Download official get-ai-gateway.sh script:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/higress-group/higress-standalone/main/all-in-one/get-ai-gateway.sh -o get-ai-gateway.sh
+chmod +x get-ai-gateway.sh
+```
+
+### Step 2: Gather Configuration
+
+Ask user for:
+
+1. **LLM Provider API Keys** (at least one required):
+
+   **Top Commonly Used Providers:**
+   - Aliyun Dashscope (Qwen): `--dashscope-key`
+   - DeepSeek: `--deepseek-key`
+   - Moonshot (Kimi): `--moonshot-key`
+   - Zhipu AI: `--zhipuai-key`
+   - Claude Code (OAuth mode): `--claude-code-key` (run `claude setup-token` to get token)
+   - Claude: `--claude-key`
+   - Minimax: `--minimax-key`
+   - Azure OpenAI: `--azure-key`
+   - AWS Bedrock: `--bedrock-key`
+   - Google Vertex AI: `--vertex-key`
+   - OpenAI: `--openai-key`
+   - OpenRouter: `--openrouter-key`
+   - Grok: `--grok-key`
+
+   To configure additional providers beyond the above, run `./get-ai-gateway.sh --help` to view the complete list of supported models and providers.
+
+2. **Port Configuration** (optional):
+   - HTTP port: `--http-port` (default: 8080)
+   - HTTPS port: `--https-port` (default: 8443)
+   - Console port: `--console-port` (default: 8001)
+
+3. **Auto-routing** (optional):
+   - Enable: `--auto-routing`
+   - Default model: `--auto-routing-default-model`
+
+### Step 3: Run Setup Script
+
+Run script in non-interactive mode with gathered parameters:
+
+```bash
+./get-ai-gateway.sh start --non-interactive \
+  --dashscope-key sk-xxx \
+  --openai-key sk-xxx \
+  --auto-routing \
+  --auto-routing-default-model qwen-turbo
+```
+
+**Automatic Repository Selection:**
+
+The script automatically detects your timezone and selects the geographically closest registry for both:
+- **Container image** (`IMAGE_REPO`)
+- **WASM plugins** (`PLUGIN_REGISTRY`)
+
+| Region | Timezone Examples | Selected Registry |
+|--------|------------------|-------------------|
+| China & nearby | Asia/Shanghai, Asia/Hong_Kong, etc. | `higress-registry.cn-hangzhou.cr.aliyuncs.com` |
+| Southeast Asia | Asia/Singapore, Asia/Jakarta, etc. | `higress-registry.ap-southeast-7.cr.aliyuncs.com` |
+| North America | America/*, US/*, Canada/* | `higress-registry.us-west-1.cr.aliyuncs.com` |
+| Others | Default fallback | `higress-registry.cn-hangzhou.cr.aliyuncs.com` |
+
+**Manual Override (optional):**
+
+If you want to use a specific registry:
+
+```bash
+IMAGE_REPO="higress-registry.ap-southeast-7.cr.aliyuncs.com/higress/all-in-one" \
+PLUGIN_REGISTRY="higress-registry.ap-southeast-7.cr.aliyuncs.com" \
+  ./get-ai-gateway.sh start --non-interactive \
+  --dashscope-key sk-xxx \
+  --openai-key sk-xxx
+```
+
+### Step 4: Verify Deployment
+
+After script completion:
+
+1. Check container is running:
+   ```bash
+   docker ps --filter "name=higress-ai-gateway"
+   ```
+
+2. Test gateway endpoint:
+   ```bash
+   curl http://localhost:8080/v1/models
+   ```
+
+3. Access console (optional):
+   ```
+   http://localhost:8001
+   ```
+
+### Step 5: Configure OpenClaw Plugin
+
+If user wants to use Higress with OpenClaw, install the plugin:
+
+#### Automatic Installation
+
+```bash
+# Install plugin for OpenClaw
+RUNTIME="openclaw"
+RUNTIME_DIR="$HOME/.openclaw"
+PLUGIN_SRC="scripts/plugin"
+
+# Install plugin
+PLUGIN_DEST="$RUNTIME_DIR/extensions/higress-ai-gateway"
+echo "Installing Higress AI Gateway plugin for $RUNTIME..."
+mkdir -p "$(dirname "$PLUGIN_DEST")"
+[ -d "$PLUGIN_DEST" ] && rm -rf "$PLUGIN_DEST"
+cp -r "$PLUGIN_SRC" "$PLUGIN_DEST"
+echo "✓ Plugin installed at: $PLUGIN_DEST"
+
+# Configure provider
+echo ""
+echo "Configuring provider..."
+$RUNTIME models auth login --provider higress
+```
+
+The plugin will guide you through an interactive setup for:
+1. Gateway URL (default: `http://localhost:8080`)
+2. Console URL (default: `http://localhost:8001`)
+3. API Key (optional for local deployments)
+4. Model list (auto-detected or manually specified)
+5. Auto-routing default model (if using `higress/auto`)
+4. Model list (auto-detected or manually specified)
+5. Auto-routing default model (if using `higress/auto`)
+
+### Step 6: Manage API Keys (optional)
+
+After deployment, manage API keys without redeploying:
+
+```bash
+# View configured API keys
+./get-ai-gateway.sh config list
+# Add or update an API key (hot-reload, no restart needed)
+./get-ai-gateway.sh config add --provider <provider> --key <api-key>
+# Remove an API key (hot-reload, no restart needed)
+./get-ai-gateway.sh config remove --provider <provider>
+```
+
+**Note:** Changes take effect immediately via hot-reload. No container restart required.
+
+## CLI Parameters Reference
+
+### Basic Options
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `--non-interactive` | Run without prompts | - |
+| `--http-port` | Gateway HTTP port | 8080 |
+| `--https-port` | Gateway HTTPS port | 8443 |
+| `--console-port` | Console port | 8001 |
+| `--container-name` | Container name | higress-ai-gateway |
+| `--data-folder` | Data folder path | ./higress |
+| `--auto-routing` | Enable auto-routing feature | - |
+| `--auto-routing-default-model` | Default model when no rule matches | - |
+
+### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `PLUGIN_REGISTRY` | Registry URL for container images and WASM plugins (auto-selected based on timezone) | `higress-registry.cn-hangzhou.cr.aliyuncs.com` |
+
+**Auto-Selection Logic:**
+
+The registry is automatically selected based on your timezone:
+
+- **China & nearby** (Asia/Shanghai, etc.) → `higress-registry.cn-hangzhou.cr.aliyuncs.com`
+- **Southeast Asia** (Asia/Singapore, etc.) → `higress-registry.ap-southeast-7.cr.aliyuncs.com`
+- **North America** (America/*, etc.) → `higress-registry.us-west-1.cr.aliyuncs.com`
+- **Others** → `higress-registry.cn-hangzhou.cr.aliyuncs.com` (default)
+
+Both container images and WASM plugins use the same registry for consistency.
+
+**Manual Override:**
+
+```bash
+PLUGIN_REGISTRY="higress-registry.ap-southeast-7.cr.aliyuncs.com" \
+  ./get-ai-gateway.sh start --non-interactive ...
+```
+
+### LLM Provider API Keys
+
+**Top Providers:**
+
+| Parameter | Provider |
+|-----------|----------|
+| `--dashscope-key` | Aliyun Dashscope (Qwen) |
+| `--deepseek-key` | DeepSeek |
+| `--moonshot-key` | Moonshot (Kimi) |
+| `--zhipuai-key` | Zhipu AI |
+| `--claude-code-key` | Claude Code (OAuth mode - run `claude setup-token` to get token) |
+| `--claude-key` | Claude |
+| `--openai-key` | OpenAI |
+| `--openrouter-key` | OpenRouter |
+| `--gemini-key` | Google Gemini |
+| `--groq-key` | Groq |
+
+**Additional Providers:**
+
+`--doubao-key`, `--baichuan-key`, `--yi-key`, `--stepfun-key`, `--minimax-key`, `--cohere-key`, `--mistral-key`, `--github-key`, `--fireworks-key`, `--togetherai-key`, `--grok-key`, `--azure-key`, `--bedrock-key`, `--vertex-key`
+
+## Managing Configuration
+
+### API Keys
+
+```bash
+# List all configured API keys
+./get-ai-gateway.sh config list
+# Add or update an API key (hot-reload)
+./get-ai-gateway.sh config add --provider deepseek --key sk-xxx
+# Remove an API key (hot-reload)
+./get-ai-gateway.sh config remove --provider deepseek
+```
+
+**Supported provider aliases:**
+
+`dashscope`/`qwen`, `moonshot`/`kimi`, `zhipuai`/`zhipu`, `togetherai`/`together`
+
+### Routing Rules
+
+```bash
+# Add a routing rule
+./get-ai-gateway.sh route add --model claude-opus-4.5 --trigger "深入思考|deep thinking"
+# List all rules
+./get-ai-gateway.sh route list
+# Remove a rule
+./get-ai-gateway.sh route remove --rule-id 0
+```
+
+See [higress-auto-router](../higress-auto-router/SKILL.md) for detailed documentation.
+
+## Access Logs
+
+Gateway access logs are available at:
+
+```
+$DATA_FOLDER/logs/access.log
+```
+
+## Related Skills
+
+- **higress-auto-router**: Configure automatic model routing using CLI commands
+  See: [higress-auto-router](../higress-auto-router/SKILL.md)
+
+## Examples
+
+### Example 1: Basic Deployment with Dashscope
+
+**User:** 帮我部署一个Higress AI网关，使用阿里云的通义千问
+
+**Steps:**
+1. Download script
+2. Get Dashscope API key from user
+3. Run (script auto-detects timezone and selects optimal registry):
+   ```bash
+   ./get-ai-gateway.sh start --non-interactive \
+     --dashscope-key sk-xxx
+   ```
+
+**Response:**
+
+```
+Auto-detected timezone: Asia/Shanghai
+Selected plugin registry: higress-registry.cn-hangzhou.cr.aliyuncs.com
+
+✅ Higress AI Gateway 部署完成！
+
+网关地址: http://localhost:8080/v1/chat/completions
+控制台: http://localhost:8001
+日志目录: ./higress/logs
+
+已配置的模型提供商:
+- Aliyun Dashscope (Qwen)
+
+测试命令:
+curl 'http://localhost:8080/v1/chat/completions' \
+  -H 'Content-Type: application/json' \
+  -d '{"model": "qwen-turbo", "messages": [{"role": "user", "content": "Hello!"}]}'
+```
+
+### Example 2: Full Integration with OpenClaw
+
+**User:** 完整配置Higress和OpenClaw的集成
+
+**Steps:**
+1. Deploy Higress AI Gateway (auto-detects timezone)
+2. Install and configure OpenClaw plugin
+3. Enable auto-routing
+
+**Response:**
+
+```
+Auto-detected timezone: Asia/Shanghai
+Selected plugin registry: higress-registry.cn-hangzhou.cr.aliyuncs.com
+
+✅ Higress AI Gateway 集成完成！
+
+1. 网关已部署:
+   - HTTP: http://localhost:8080
+   - Console: http://localhost:8001
+   - 容器镜像: Hangzhou (自动选择)
+   - 插件镜像: Hangzhou (自动选择)
+
+2. OpenClaw 插件配置:
+   Plugin installed at: /root/.openclaw/extensions/higress-ai-gateway
+   Run: openclaw models auth login --provider higress
+
+3. 自动路由:
+   已启用，使用 model="higress/auto"
+
+需要我帮你配置自动路由规则吗？
+```
+
+### Example 3: Manage API Keys
+
+**User:** 帮我查看当前配置的API keys，并添加一个DeepSeek的key
+
+**Steps:**
+1. List current API keys:
+   ```bash
+   ./get-ai-gateway.sh config list
+   ```
+
+2. Add DeepSeek API key:
+   ```bash
+   ./get-ai-gateway.sh config add --provider deepseek --key sk-xxx
+   ```
+
+**Response:**
+
+```
+当前配置的API keys:
+
+  Aliyun Dashscope (Qwen): sk-ab***ef12
+  OpenAI:                  sk-cd***gh34
+
+Adding API key for DeepSeek...
+
+✅ API key updated successfully!
+
+Provider: DeepSeek
+Key: sk-xx***yy56
+
+Configuration has been hot-reloaded (no restart needed).
+```
+
+### Example 4: North America Deployment
+
+**User:** 帮我部署Higress AI网关
+
+**Context:** User's timezone is America/Los_Angeles
+
+**Steps:**
+1. Download script
+2. Get API keys from user
+3. Run (script auto-detects timezone and selects North America mirror):
+   ```bash
+   ./get-ai-gateway.sh start --non-interactive \
+     --openai-key sk-xxx \
+     --openrouter-key sk-xxx
+   ```
+
+**Response:**
+
+```
+Auto-detected timezone: America/Los_Angeles
+Selected plugin registry: higress-registry.us-west-1.cr.aliyuncs.com
+
+✅ Higress AI Gateway 部署完成！
+
+网关地址: http://localhost:8080/v1/chat/completions
+控制台: http://localhost:8001
+日志目录: ./higress/logs
+
+镜像优化:
+- 容器镜像: North America (基于时区自动选择)
+- 插件镜像: North America (基于时区自动选择)
+
+已配置的模型提供商:
+- OpenAI
+- OpenRouter
+```
+
+## Troubleshooting
+
+For detailed troubleshooting guides, see [TROUBLESHOOTING.md](references/TROUBLESHOOTING.md).
+
+Common issues:
+- **Container fails to start**: Check Docker status, port availability, and container logs
+- **"too many open files" error**: Increase `fs.inotify.max_user_instances` to 8192
+- **Gateway not responding**: Verify container status and port mapping
+- **Plugin not recognized**: Check installation path and restart runtime
+- **Auto-routing not working**: Verify model list and routing rules
+- **Timezone detection fails**: Manually set `IMAGE_REPO` environment variable