oc CLI
安装并使用 Open Connector 官方命令行客户端。
oc 是 Open Connector 官方命令行客户端。它通过 @open-connector/sdk 调用原生 /api/v1 API，默认输出人类可读内容；Agent 与脚本通过显式传入 --json 获得稳定的结构化输出。
安装
curl -fsSL https://github.com/okxiaoliang4/open-connector/releases/latest/download/install.sh | sh安装脚本会把 macOS 或 Linux 的免运行时二进制文件下载到 ~/.local/bin。Windows 用户可以从 GitHub Releases 下载 oc-windows-x64.exe。
登录实例
先在 SaaS Console 创建项目范围 API Key，再保存 API 地址、Key 与可选的默认 Entity ID：
printf '%s' "$OPEN_CONNECTOR_API_KEY" | oc login \
--url https://api.openconnector.dev \
--key - \
--entity user_123配置会写入 ~/.config/oc/config.json。这里的 login 只是保存已有项目 Key，并不是 OAuth 登录流程。自托管时传入自己的公网 Server Origin。
诊断、发现、连接并执行 Tool
# 1. 检查配置，并发现或检查准确的 Tool slug
oc doctor
oc search "create a github issue" --toolkit github
oc tools info GITHUB_ISSUES_CREATE SLACK_CHAT_POST_MESSAGE
oc execute GITHUB_ISSUES_CREATE --dry-run --data @issue.json
# 2. 搜索 Toolkit，并选择可用的连接策略
oc link
# 名称查询只返回少量按相关度排序的服务端结果
oc link X
# 3. 执行已经审阅的输入
oc execute GITHUB_ISSUES_CREATE \
--connected-account conn_... \
--data @issue.jsonAPI Key 或 Basic Auth Provider 不需要 OAuth 重定向，直接提交凭证对象：
oc connected-accounts link telegram \
--auth-method telegram.api_key \
--credentials @credentials.json命令
| 命令 | 用途 |
|---|---|
oc doctor | 检查本地配置、认证与 Server 可达性 |
oc search <query...> | 根据自然语言任务排序原生 Catalog 匹配结果 |
oc execute <slug> --dry-run / --data <input> | 预览或执行一个已知 Tool |
oc link [toolkit] | 在人类终端中引导搜索 Toolkit 并建立 Connected Account |
oc toolkits list [--query] / info <slug> | 发现 Toolkit，并查看元数据与准确的 Auth Method ID |
oc tools list [toolkit] [--query] / info <slug...> [--allow-missing] | 筛选 Tool；查看单个完整详情，或在一次请求中批量查看最多 20 个完整详情 |
oc tools execute <slug> --data <input> | 代表 Entity 或指定 Connected Account 执行 Tool |
oc auth-configs create <toolkit> --auth-method <id> | 创建托管或自带凭证的 Auth Config |
oc auth-configs list / info <id> | 查找并检查 Auth Config |
oc connected-accounts link [toolkit] | 搜索并通过 OAuth、API Key / Basic 或 app-only 认证建立连接 |
oc connected-accounts wait <id> [--timeout 5m] | 继续等待一个已有的 pending connection |
oc connected-accounts list / info <id> / delete <id> --force | 管理项目范围内的连接；删除需要显式确认 |
oc triggers list [toolkit] / info <slug> | 发现实时 Trigger Type，并检查单个定义 |
oc triggers status [filters] | 检查当前 Project 的 Trigger Instance |
oc triggers create <slug> --connected-account <id> | 创建或重新配置 Trigger Instance |
oc triggers enable <id> / disable <id> --force | 启用或显式禁用 Trigger Instance |
oc triggers delete <id> --dry-run / --force | 预览或删除 Trigger Instance，并协调其上游 Source |
oc proxy <url> --connection <id> | 使用连接账户的凭证发起类似 curl 的请求 |
oc setup [agent...] | 交互选择检测到的客户端，或为显式指定的宿主安装插件 |
oc upgrade [--to <version>] | 升级 CLI，并更新已记录的 Skill 与 Agent Plugin |
使用 oc <command> --help 查看完整选项。全局参数是 --json 与 --entity <id>。
JSON 输入与输出
--data 和 --credentials 支持内联 JSON、@path/to/file.json 或用 - 从 stdin 读取：
oc tools execute TOOL_SLUG --data @input.json
cat input.json | oc tools execute TOOL_SLUG --data -
oc --json toolkits list | jq '.items[].slug'默认输出适合人在终端中阅读。Toolkit 与 Tool 列表会显示带表头的表格、分页信息、--cursor 下一页提示和可复制的、支持批量的 info 命令。Agent 与 Shell 脚本在解析、保存或管道处理输出时应显式传入 --json。主要结果格式不会根据是否连接 TTY 自动变化；只有 stderr 上的临时获取状态仅在交互式 TTY 中显示。
主要结果写入 stdout；授权 URL、警告和错误写入 stderr。tools info 支持 1–20 个 slug，并始终返回 { tools, errors, summary }，其中每个 tools[slug] 都是完整的 Tool 详情。部分失败默认返回非零退出码，只有显式传入 --allow-missing 才视为成功。doctor 不健康或命令失败时返回非零退出码，结构化诊断可通过 --json 获取。Key、Client Secret 与凭证对象应通过 stdin 的 -（或命令支持的 @file）读取。写操作先用 --dry-run 预览；删除连接先预览，再显式传 --force。
在人类 TTY 中，oc link 使用有上限的服务端搜索发现 Toolkit；只有一个启用的 Auth Config 时会自动复用，存在多个连接策略或 Auth Method 时才会提示选择。Hosted connection 页面默认在浏览器中打开，传 --no-browser 可只打印 URL。--json、--no-input 与非 TTY 调用永不提示、也不打开浏览器。使用 --timeout 5m 调整等待时间，或用 --no-wait 立即返回 pending connection；超时后应运行 oc connected-accounts wait <id> 继续等待，不要重复创建 link。
Skill 与 Agent Plugin 生命周期
oc skills install codex|claude 成功后，会把 Agent 和准确安装路径记录到
~/.config/oc/installations.json。oc skills refresh 使用当前 CLI 内嵌的
Skill 更新所有记录；oc upgrade 替换二进制后会自动执行该更新。
独立的 Open Connector Agent Plugin 是 Agent Plugins v1 包，同时提供 Claude Marketplace 包装：
oc setup
oc setup codex claude --dry-run
oc setup codex claude hermes openclaw
oc setup --refresh不传 Agent 时，oc setup 会先检测客户端，再打开只包含可自动安装宿主的多选界面；
需要手动安装的已检测宿主会单独提示。脚本和 --json 调用必须显式传入 Agent，
非 TTY 环境不会弹出交互。
支持 Claude、Codex、Hermes、OpenClaw、VS Code、Cursor、Grok Bot、Kiro、
GitHub Copilot 与 NanoClaw。Agent Plugins 规范统一包和发现方式，但明确不统一
各客户端的安装入口。因此 oc setup 会自动调用已经验证的宿主 CLI；没有本地
安装 API 的客户端会返回官方配置链接，并且不会被错误地记录成“已安装”。
这类命令以 manual 状态成功退出，并输出宿主内需要继续完成的步骤。
当前边界
CLI 当前覆盖 Toolkit、Tool 与实时 Trigger 发现，Auth Config、Connected Account、Trigger Instance 控制、Tool 执行和凭证代理。实时 Trigger 监听/转发、出站 Webhook Subscription 管理、内联 JavaScript Sandbox、语义搜索与 OAuth Cloud Login 尚不在当前 CLI 能力范围内。