本文へスキップ
OcHub

開発者向け連携

プロバイダーのコンソール、Web サイト、自動化を OcHub と連携します。

更新日 Markdown で表示

OcHub は、プロバイダーの Web サイトとローカル自動化向けにバージョン付きの連携機能を 提供します。まず Deep Link で、デスクトップアプリに確認・編集 可能なインポートプレビューを開くリンクを生成できます。

利用できる連携

連携 用途
Deep Link モデルプロバイダー、直接接続、MCP サーバー、スキルのインポート
ochcli ローカル自動化で Deep Link を解析、検証、ドライラン、適用

Deep Link は設定の転送手段であり、認証ではありません。Payload に API キーが含まれる 場合は、URL 全体を秘密情報として保護してください。

概要スナップショットを読む

ochcli overview はコマンドの実行環境を読み取ります。既存の SSH エイリアスを使って 2 行目を実行すると、リモートノードの情報を取得できます。

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

範囲を指定しない場合は直近 24 時間です。--from と --to には秒単位の UTC Unix タイムスタンプを指定します。期間は 0 より長く、366 日以内である必要があります。

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

結果には generatedAt、window と、gateway、routing、apps、usage、trend、 performance、recentRequests の各セクションがあります。各セクションは data または error を含みます。コマンドが成功しても一部の読み取りが失敗している場合があるため、 欠損値を解釈する前に確認してください。不正な期間ではコマンド自体が失敗します。 各セクションは個別に取得され、プロセス間の原子的なトランザクションではありません。

上流への検査、セッションの取り込み、対象設定への書き込みは行いません。 performance はプロバイダー/取得元グループを最大 20 件、recentRequests は保持された 詳細を最大 10 件含みます。性能プレビューの合計を取得元全体の合計にせず、ルート設定を 実リクエストの追跡として扱わないでください。

デスクトップのリモートプロトコルでは 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