跳到正文
OcHub

开发者集成

将供应商控制台、网站和自动化流程接入 OcHub。

更新于 查看 Markdown

OcHub 为供应商网站和本地自动化提供带版本的集成接口。可以从 Deep Link 开始,生成一个在桌面端打开、可检查且可编辑的导入预览。

可用集成

集成 适用场景
Deep Link 导入模型供应商、直接连接、MCP 服务器或技能
ochcli 在本地自动化中解析、校验、演练或执行 Deep Link

Deep Link 只负责传输配置,不是身份认证机制。Payload 如果包含 API Key,必须将完整 URL 按密钥管理。

读取总览快照

ochcli overview 读取命令执行所在的环境。例如,用已有 SSH 别名执行第二条命令,读取远程节点:

ochcli overview --json
ssh devbox ochcli overview --json

未指定范围时读取最近 24 小时。--from 与 --to 接受以秒为单位的 UTC Unix 时间戳, 时间跨度必须大于零且不超过 366 天:

ochcli overview --from 1791763200 --to 1791849600 --json

结果包含 generatedAt、window,以及 gateway、routing、apps、usage、trend、 performance、recentRequests 分区。每个分区包含 data 或 error。命令整体成功时仍可能 有个别分区读取失败,解释缺失值前必须检查对应字段;无效时间范围会让命令失败。 各分区分别采样,不是跨进程的原子事务。

命令不会探测上游、导入会话或写入目标配置。performance 最多预览 20 个供应商与来源分组, recentRequests 最多包含十条保留明细。不能把性能预览重新加总为完整来源统计,也不能把 路由配置当成实际请求轨迹。

桌面远程协议使用 overview-v1,并要求 provider.read、gateway.read 与 usage.read。 这些协议权限不会将普通 SSH 账户变成只读账户。显示数据的含义参见总览教程。

编辑草稿与明确应用

ochcli editor 与桌面连接编辑器使用同一份独立草稿。保存允许未完成字段和格式错误的 原始文本,不会覆盖正式 Provider,也不会写入应用配置。输入文件是 EditorDraftInput, 不是目标工具的原始配置文件。下面使用无效的示例凭据,不要直接用于真实服务:

{
  "provider": {
    "id": "work-api",
    "name": "Work API",
    "settingsConfig": {
      "env": {
        "ANTHROPIC_BASE_URL": "https://api.example.test",
        "ANTHROPIC_AUTH_TOKEN": "REPLACE_ME"
      }
    }
  },
  "originalProviderId": null,
  "baseProviderHash": null,
  "editorState": {},
  "rawDocuments": null,
  "commonConfig": null
}

将它保存为 draft-input.json,再创建草稿:

ochcli editor save work-draft --app claude --from draft-input.json --json
ochcli editor list --app claude --json
ochcli editor get work-draft --app claude --json
命令 用途
editor save ID --app APP --from FILE 新建独立草稿;首次不传 expected revision
editor save ID --app APP --from FILE --expected-revision N 只在当前版本仍为 N 时更新草稿
editor apply ID --app APP --revision N --on-drift abort 校验并应用指定版本,不能用旧版本覆盖新编辑
editor delete ID --app APP --revision N 删除指定版本的草稿,不删除正式连接
editor undo RECEIPT_ID 在完整回执和写入后状态核对通过时撤回该次应用

使用返回的 revision,不要猜测或永久写死。--on-drift 支持 abort(默认)、save、 revert,分别为遇到外部变化时中止、保存当前版本、明确回退。该策略不绕过草稿版本或 Provider 基线冲突。应用失败返回非零退出码,结构化错误包含失败阶段、恢复是否需要介入 以及可用的回执;草稿保留。externalConfirmation 表示还需要外部应用确认,不代表已写入成功。

editorState 保存编辑界面的未完成输入;rawDocuments 按 codec 文件顺序保存原文。 原文存在时,应用必须重新解析它,不能仅采用旧 provider 的解析结果。编辑已有连接应保留 原草稿的 originalProviderId 和 baseProviderHash。不要把脱敏输出覆盖回原草稿。 默认 get 输出会隐藏原始编辑状态、原文和共享片段;确需完整内容时使用 --show-secrets 并按密钥文件管理。--dry-run 只报告操作意图,不代替 codec 检查或最终文件差异。

每个子命令的实际选项可通过 ochcli editor --help 和 ochcli editor apply --help 查看。

Navigation

Type to search…

↑↓ navigate↵ selectEsc close