@opendevflow/bridge
v0.1.6
Published
OpenDevFlow local bridge for code context scan and local command execution.
Maintainers
Readme
@opendevflow/bridge
OpenDevFlow Bridge 用于把用户本机代码接入 OpenDevFlow 平台。
Bridge 会在本机运行,扫描指定代码根目录下的项目结构。用户在平台确认本次工作流相关项目后,Bridge 会把已确认项目的源码包上传到平台的工作流级临时代码区,用于 AI 在所有阶段读取代码事实、生成文档和执行代码修改。
当前架构下,编译、测试、lint 等验证优先在服务器 Docker 隔离环境中执行;Bridge 主要负责扫描、上传源码副本,以及交付归档前把服务器临时代码区的 diff 同步回本地。Git 拉取/推送是后续扩展,不在当前 Bridge 中实现。
Bridge 是一个本地长连接进程。启动后需要保持终端窗口运行;关闭终端窗口后,平台将无法继续扫描代码项目、上传源码副本或同步修改回本地。
使用方式
npx --registry https://registry.npmjs.org/ @opendevflow/bridge --server http://localhost:8765 --client-key <客户端标识> --root <本地代码根目录>示例:
npx --registry https://registry.npmjs.org/ @opendevflow/bridge --server http://localhost:8765 --client-key muke-mac --root /Users/muke/projects参数
--server:OpenDevFlow 后端地址,默认http://localhost:8765。--client-key:平台中登记的 Bridge 客户端标识,也可以使用环境变量OPENDEVFLOW_CLIENT_KEY。--root:本地代码根目录,默认当前目录,也可以使用环境变量OPENDEVFLOW_ROOT。--keywords:源码扫描关键词,英文逗号分隔。当前主要保留为调试参数,普通使用不需要手工指定。--max-source-files:每个项目最多上传的源码片段文件数,默认24。--max-snapshot-chars:单次快照最大字符数,默认70000。--help:查看帮助。
安全说明
- Bridge 初次扫描只上传项目结构、Git 状态和构建标记;用户确认本次工作流相关项目后,才会上传这些项目的源码包。
- 临时源码包只用于平台侧阶段上下文和服务器 Docker 验证;最终同步回本地前,用户仍可通过平台查看 diff 和执行记录。
- 本地命令执行前会进行基础危险命令拦截。
- 当前版本是 MVP,后续建议增加客户端密钥、同步前二次确认、源码包大小策略、忽略规则配置和更完整的审计能力。
