VS Code直连OpenClawGateway指南
要在 VS Code 中通过 openclaw-vscode 插件实现与 OpenClaw Gateway 的 WebSocket 直连,你需要完成插件安装、网关配置和连接建立三个核心步骤。以下是一个基于实践指南的完整流程。
一、安装 openclaw-vscode 插件
openclaw-vscode 插件是连接 VS Code 与 OpenClaw Gateway 的桥梁。它通过在编辑器侧边栏嵌入一个完整的 OpenClaw 对话面板,让你无需切换窗口即可与 AI Agent 交互,并支持通过 WebSocket 协议直连本地或远程的 OpenClaw Gateway 。
安装步骤:
- 打开 VS Code。
- 进入扩展市场(Extensions,或使用快捷键
Ctrl+Shift+X/Cmd+Shift+X)。 - 在搜索框中输入 “OpenClaw” 或 “openclaw-vscode”。
- 找到由 “OwenLiuyuxuan” 发布的 “OpenClaw-VSCode” 扩展,点击 “Install” 进行安装 。
- 安装完成后,VS Code 活动栏(最左侧)会出现一个 OpenClaw 的图标。
二、配置 OpenClaw Gateway 以启用 WebSocket
在连接插件之前,必须确保你的 OpenClaw Gateway 已正确配置并运行,且启用了 WebSocket 服务。
1. 基础网关配置
OpenClaw Gateway 默认在 http://localhost:18789 提供 WebSocket 接口 。你需要确认网关的配置文件(通常是 gateway.yaml)中包含以下关键设置:
# OpenClaw Gateway 配置示例
gateway:
port: 18789 # 网关服务端口
websocket:
enabled: true # 必须启用 WebSocket
auth:
type: token # 推荐使用令牌认证以增强安全性
cors:
allowedOrigins:
- "vscode-extension:" # 允许 VS Code 插件来源进行跨域连接
2. 启动网关
在终端中,使用以下命令启动 Gateway:
openclaw gateway start
启动后,你可以通过访问 http://localhost:18789/health 来验证服务是否健康运行 。
三、在 VS Code 中建立 WebSocket 连接
插件和网关都就绪后,即可在 VS Code 内完成连接配置。
连接配置流程:
- 点击 VS Code 活动栏上的 OpenClaw 图标,打开插件侧边栏。
- 在聊天面板中找到并点击配置按钮(通常是一个齿轮图标⚙️)。
- 在弹出的配置界面中,输入以下关键信息:
- WebSocket 地址:这是连接的核心。格式为
ws://[服务器地址]:[端口]。- 本地连接:如果 Gateway 运行在你的本地机器上,地址为
ws://localhost:18789。 - 远程连接:如果 Gateway 运行在远程服务器(如云服务器)上,地址为
ws://你的远程服务器IP:18789。请确保服务器防火墙开放了 18789 端口。
- 本地连接:如果 Gateway 运行在你的本地机器上,地址为
- 认证令牌:如果在网关配置中启用了 Token 认证,则需要在此处填入对应的令牌 。
- WebSocket 地址:这是连接的核心。格式为
- 点击“连接”或“保存并连接”按钮。
连接成功后,侧边栏的聊天界面将变为可交互状态,你可以直接在此与 OpenClaw 的 AI Agent 进行对话 。
四、进阶配置与使用技巧
1. 多环境管理
如果你需要同时管理多个 OpenClaw 实例(例如开发、测试、生产环境),openclaw-vscode 插件支持配置多个连接配置文件。你可以通过下拉菜单快速在不同环境的配置间切换,无需反复修改地址 。
2. 与 VS Code Remote-SSH 深度集成
这是该插件一个非常强大的特性。当你使用 VS Code 的 Remote-SSH 扩展连接到远程服务器进行开发时,你可以将插件的 WebSocket 地址指向同一台服务器上的 Gateway(例如 ws://localhost:18789)。这样,你就能在远程编写代码的同时,无缝管理部署在同一远程环境中的 AI 网关,实现编码与 AI 辅助的“远程一体化”工作流 。
3. 利用快捷命令提升效率
插件注册了多个 VS Code 命令,可通过命令面板(Ctrl+Shift+P / Cmd+Shift+P)快速调用:
OpenClaw: Connect—— 建立连接OpenClaw: Disconnect—— 断开连接OpenClaw: New Chat—— 开启新对话OpenClaw: Clear History—— 清除当前会话历史
4. 拖拽与上下文感知
你可以直接将 VS Code 编辑器中的代码片段或文件拖拽到插件的聊天输入框中,插件会自动将其作为上下文发送给 AI Agent,使得问答更具针对性 。
五、方案对比与选型建议
为了帮助你更好地理解 openclaw-vscode 插件的定位,下表将其与另一种集成方案 ACP 协议进行对比:
| 特性维度 | openclaw-vscode 插件 (WebSocket直连) | ACP 协议桥接 |
|---|---|---|
| 核心原理 | 通过 WebSocket 与 Gateway 直接通信,实现侧边栏聊天。 | 通过 stdio + WebSocket 双通道,建立 IDE 与 Agent 间的双向通信隧道,允许 IDE 驱动 Agent 。 |
| 交互模式 | 开发者主动发起对话(问答式)。 | IDE 可自动触发 Agent 执行任务并更新编辑器状态(驱动式)。 |
| 配置复杂度 | 低,即装即用,图形化配置。 | 中,需要部署 acp CLI 工具并进行协议桥接 。 |
| 最佳适用场景 | 日常轻量对话、配置管理、远程开发一体化。 | 复杂的自动化编程任务、需要精确控制步骤的 Agent 协同工作流 。 |
| 学习成本 | 低。 | 中到高。 |
实践建议:
- 新手或日常使用:强烈推荐从 openclaw-vscode 插件 开始。它安装简单、配置直观,能立即解决窗口频繁切换的问题,显著提升日常编码时与 AI 交互的效率 。
- 远程开发场景:如果你在使用 VS Code Remote-SSH,那么 openclaw-vscode 插件是必选方案,它能完美实现远程编码与远程 AI 管理的无缝结合 。
- 高阶自动化需求:当你需要实现如“自动代码审查”、“多步骤任务分解执行”等复杂场景时,可以进一步探索 ACP 协议,它与 openclaw-vscode 插件并不冲突,可以组合使用 。
参考来源
AtomGit 是由开放原子开源基金会联合 CSDN 等生态伙伴共同推出的新一代开源与人工智能协作平台。平台坚持“开放、中立、公益”的理念,把代码托管、模型共享、数据集托管、智能体开发体验和算力服务整合在一起,为开发者提供从开发、训练到部署的一站式体验。
更多推荐

所有评论(0)