Skip to content

Collab ​

Collab 用于在你已经打开的会话中与队友一起协作。当队友应当看到完整上下文和实时进度,而不是只收到截图或静态导出时,就使用它。主持方(host)的 omp 仍然是权威来源:模型和工具会继续在主持方所在机器上运行,而访客(guest)可以在各自的 omp 或浏览器中看到相同的转录和状态。

分享你当前的会话 ​

在你想分享的交互式 omp 会话中,运行:

/collab

omp 会开始分享并显示:

  • 一个终端命令,例如 omp join "<room>.<secret>",
  • 一个可点击的浏览器链接,
  • 该浏览器链接对应的二维码,以及
  • 一条提示,告诉你这个首次生成的链接允许访客向 agent 发送提示词。

把一个完整的链接发给你的队友。终端形式和浏览器形式授予相同的权限。让 omp 保持运行在主持方所在机器上;那台机器会继续运行 agent、发起模型请求并执行工具。

在主持过程中再次运行 /collab 会重新打印完全控制的链接和二维码。要查看谁已连接,运行:

/collab status

参与者列表会标出主持方,并标记以只读(view-only)方式加入的访客。

分享只读链接 ​

把只读链接用于评审、演示,或任何只需要观察、而不需要操控工作进展的人:

/collab view

如有必要,这会开始分享;如果已存在 collab 会话,则会打印它的只读链接。只读访客可以看到之前的转录和实时更新(包括工具卡片和子代理转录),但不能发送提示词、打断、应答请求或控制子代理。

一个主持中的会话同时拥有完全控制链接和只读链接。你可以不重启会话就给不同的人不同的访问权限:

/collab       # print the full-control link
/collab view  # print the view-only link

加入会话 ​

任选以下方式之一。

从 omp 会话中加入 ​

把链接粘贴到交互式 TUI 中:

/join "<link>"

在参与期间,你当前的本地会话会被暂时搁置。当你离开——或者主持方结束分享——omp 会恢复你在加入之前所使用的会话。

当你正在主持、或已经以访客身份连接时,你不能加入。请先运行 /collab stop 或 /leave。

从新终端加入 ​

直接在共享会话中启动 omp:

omp join "<link>"

omp join 需要交互式终端。给链接加上引号,以免你的 shell 解释 # 之类的字符。

从浏览器加入 ​

打开浏览器链接或扫描其二维码。无需安装 omp。页面会自动连接,并显示转录、流式输出、工具卡片、参与者和子代理。完全控制的浏览器链接还会启用消息输入框(composer)、打断按钮、子代理控制,以及对主持方提问(host questions)的应答;只读链接则会明确标示其为只读。

加入之后,omp 会先加载已有的转录,然后再跟随实时活动。终端访客还能看到主持方的会话状态,包括工作目录、模型、上下文占用和费用,但不会切换进主持方的工作目录。

协同工作 ​

操作主持方完全控制访客只读访客
阅读已有及实时转录可以可以可以
查看工具活动和子代理转录可以可以可以
向 agent 输入提示词可以可以不可以
按 Esc 打断当前回复可以可以不可以
应答主持方需选择选项或编辑文本的请求可以可以不可以
查看、发消息、停止或复活主持方的子代理可以可以不可以
运行主持方本地的 slash 命令、shell 命令、Python 或技能可以不可以不可以

访客发送的提示词会以他们的显示名称标注在转录中。该名称只是给人看的署名;它不是经过认证的身份,也不会作为指令提供给模型。

当 agent 请主持方选择一个选项或编辑文本时,每个已连接的完全控制访客都可能收到同一个请求。第一个回答或取消会决定结果,其余副本会被关闭。

在终端中,完全控制访客可以按 Alt+A 打开 Agent Hub,查看主持方的子代理、阅读它们的转录、给它们发消息、停止它们或复活它们。这些操作会影响主持方机器上正在运行的工作。只读访客可以查看相同的子代理信息,但不能更改它。

仅主持方可用的命令(host-only)仍只归主持方,包括 /model、/compact、/resume、/branch、! shell 命令、$ Python 和技能。终端访客仍可使用下列本地命令,而不会影响主持方的会话:

访客本地命令用途
/dump、/export、/copy复制或导出访客能看到的内容
/help、/hotkeys打开本地帮助
/theme、/settings更改访客机器上的设置;主持方不受影响
/collab显示访客的 collab 状态
/leave、/exit、/quit/leave 恢复先前的会话;/exit 和 /quit 关闭 omp

离开、停止与重连 ​

访客通过以下命令离开:

/leave

omp 会关闭共享视图,并恢复该访客先前的本地会话。离开不会停止主持方,也不会断开其他任何人。浏览器访客使用页面上的离开(leave)控件。

主持方可以用以下任一命令结束对所有人的分享:

/collab stop
/leave

访客会看到会话已结束,终端访客会回到各自先前的本地会话。再次运行 /collab 会创建新的链接;旧链接不能加入新的房间。

短暂的网络或中继(relay)中断会自动重连。omp 会显示 reconnecting… 状态,并在连接恢复时重新同步共享会话。如果房间已不存在、主持方已停止、密钥无效,或中继永久拒绝该连接,访客会话就会直接结束;如果主持方仍在分享,请向其索要一个新的链接。

权限与安全 ​

Collab 链接属于承载凭证(bearer secret):任何持有链接的人都拥有该链接对应的权限。

  • 完全控制链接包含加密密钥和一个写入令牌(write token)。持有者可以阅读完整转录、提交会让主持方的 agent 行动的提示词、打断工作、应答请求以及控制子代理。
  • 只读链接包含加密密钥,但没有写入令牌。持有者可以阅读同样可能敏感的会话历史,却无法操控它。
  • 有人使用有效链接时,不存在基于账号的身份验证或审批提示。参与者的显示名称可以由参与者自行选择。

所有会话内容在到达中继之前都会使用 AES-256-GCM 进行端到端加密。中继无法读取提示词、转录、工具详情或密钥。它能观察到房间标识符、连接数、加密帧大小以及有限的路由元数据。在浏览器链接中,房间链接放在 URL 的 fragment(片段)中,而浏览器不会在 HTTP 请求中发送 fragment。

中继本身并不会让完全控制访客变得安全。访客的提示词会由 agent 在主持方所在机器上执行,并遵循主持方配置的工具与审批策略。分享之前,请检查转录中是否有机密信息,并确认主持方的权限设置恰当。当对方只需要观察时,默认发送只读链接;协作结束后停止分享。

中继配置 ​

官方托管服务本身无需任何配置。默认情况下,/collab 使用 wss://my.omp.sh,自动推导出对应的浏览器 UI,并使用你的操作系统用户名作为参与者名称。

若要一次性使用备选中继,可以在开始分享时传入它。不带协议(scheme)的主机名默认使用安全的 WebSocket(wss://):

/collab relay.example.com

若要通过该中继以只读链接开始:

/collab view relay.example.com

若要持久化该选择,可以在 omp 中使用 /settings,或运行:

omp config set collab.relayUrl wss://relay.example.com
omp config set collab.displayName "Ada"

用以下命令验证生效的值:

omp config get collab.relayUrl
omp config get collab.displayName

如果浏览器 UI 与中继分开托管,还需要配置它的基础 URL:

omp config set collab.webUrl https://collab.example.com

collab.webUrl 必须是 http:// 或 https:// 的 URL,且不能包含查询字符串或 fragment。非本地的 URL 必须使用 HTTPS;只有 localhost 才接受纯 HTTP。生成的浏览器链接仍然指向已配置的中继。

设置默认值用途
collab.relayUrlwss://my.omp.sh当 /collab 未提供中继参数时使用的中继
collab.webUrl空浏览器 UI 的基础地址;为空时根据中继 URL 推导
collab.displayName空参与者名称;为空时依次回退到操作系统用户名、anonymous

中继 URL 可以使用 wss:// 或 https://;omp 会把两者都规范化为安全的中继连接。纯 ws:// 或 http:// 的中继 URL 只允许用于 localhost、127.0.0.1 或 ::1 这类开发端点。自定义端点必须实现 omp collab 中继服务;普通的 WebSocket 服务器是不够的。omp 目前不提供可用于生产环境的中继服务器,也不随附用于自托管的独立中继二进制文件。源码仓库中包含一个仅 WebSocket 的本地开发占位实现,但它不能提供浏览器客户端,也无法替代官方托管服务。

故障排除 ​

你看到的现象解决方法
No relay configured在 /settings 中设置 collab.relayUrl,运行 omp config set collab.relayUrl wss://…,或向 /collab 传入中继。
Stop hosting first先运行 /collab stop,再加入另一个会话。
Already in a collab session在加入另一个链接之前先运行 /leave。
访客是只读的主持方分享的是 /collab view;只有当你应当操控会话时,才索要完全控制链接。
浏览器链接能打开但无法连接确认主持方仍在分享、使用完整的当前链接,并检查自定义的 collab.webUrl 是否通过 HTTPS 提供 omp 浏览器客户端。
omp join requires an interactive terminal从 TTY 中运行它,或者改为打开浏览器链接。
访客在回复期间加入却错过了该回复等待下一次更新。如果加入之后该回复没有产生任何更新,那么这条正在进行的回复可能不会实时渲染;后续的转录和会话更新仍然会同步。

基于 oh-my-pi 上游文档整理的非官方中文文档。