orriven

終端機中的開發者工具

單一二進位檔支援 macOS、Linux 與 Windows。使用主控台帳號驗證身分，集中管理業務單元的 API 金鑰、Webhook、請求日誌與效能指標。

orriven login
orriven init
orriven keys create staging

單一二進位檔。所有命令在指定業務單元範圍內執行。

安裝

下載並安裝獨立二進位檔，執行 `orriven --version` 驗證安裝。

適用於 macOS 與 Linux。

透過 Homebrew tap 安裝

brew install orriven/tap/orriven

身分驗證

使用主控台帳號透過瀏覽器完成授權。終端機顯示一次性驗證碼，在主控台中核對並確認即可完成登入。

orriven login
  • 登入工作階段與主控台工作階段週期一致，可在帳號設定中隨時撤銷。
  • 執行 `orriven whoami` 檢視目前登入帳號及關聯的業務單元。
  • 執行 `orriven logout` 登出狀態並清除本機憑證。

請確認瀏覽器中顯示的驗證碼與終端機輸出一致後再執行授權。

專案設定

執行 orriven init 關聯組織與業務單元，設定資訊將儲存至專案根目錄的 orriven.toml。

orriven init

僅記錄作用域範圍，不包含任何憑證資訊。

organization = "…"
workspace = "…"

透過參數指定組織與業務單元，無需互動提示。

orriven init --org acme --workspace "Field Marketing"

使用者憑證安全儲存於使用者目錄。支援透過 --workspace 與 --org 暫時覆蓋作用域，或執行 orriven init --force 重新設定。在 CI 環境中自動以非互動模式執行。

命令概覽

API 金鑰

管理指定業務單元的 Secret 金鑰與公開金鑰。

  • orriven keys list

    列出有效金鑰。加入 --all 可包含已撤銷金鑰。

  • orriven keys create <name>

    產生 Secret 金鑰。金鑰內容僅顯示一次。可透過 --expires-in 設定有效期限。

  • orriven keys create-publishable <name> --origin https://…

    產生繫結至指定 Origin 的公開金鑰。

  • orriven keys revoke <key>

    立即撤銷指定的 API 金鑰。

Webhook

設定事件端點、檢視簽章金鑰、傳送測試事件及查詢投遞紀錄。

  • orriven webhooks events

    查詢支援訂閱的 Webhook 事件類型。

  • orriven webhooks create --event registration.confirmed

    註冊 Webhook 端點並取得簽章金鑰。

  • orriven webhooks ping <id>

    向指定端點傳送測試事件以驗證連線。

  • orriven webhooks deliveries <id>

    查詢投遞歷史紀錄。可透過 --status 篩選狀態。

日誌與指標

查詢 API 請求日誌及 1、7、30 天的流量與延遲指標。

  • orriven logs

    查詢最新 API 請求。支援 --follow 即時追蹤及條件篩選。

  • orriven logs get --latest --status 5xx

    取得單筆請求與回應的完整資料，或檢視最新錯誤詳細資訊。

  • orriven metrics --days 7

    檢視 1 天、7 天或 30 天的請求量、錯誤率與回應延遲。

它不做什麼

  • 不負責建立活動、票種或處理報名。相關業務需使用簽發的 API 金鑰呼叫開放 API。
  • 不支援使用 API 金鑰直接登入 CLI，僅支援主控台成員身分驗證。
  • 在無檔案系統或本機終端機的雲端代理環境中，請使用 orriven MCP 服務。

CLI 與 MCP

在本機終端機與遠端 AI 代理環境中提供一致的開發者工具功能。

終端機環境

適用於具備本機檔案系統與 Shell 的開發環境，直接基於本機專案設定執行命令。

遠端 AI 代理

適用於無本機檔案系統的雲端代理，透過 HTTPS 提供與 CLI 一一對應的工具功能。

檢視 MCP 說明

常見問題

哪些角色可以使用 CLI？
僅組織的擁有者（Owner）與管理員（Admin）具備使用權限，與主控台開發工具抽屜的權限保持一致。
CLI 與開發者 API 有何區別？
CLI 用於管理金鑰、Webhook 與監控日誌等基礎設施；活動與票務資料透過 /v1 開發者 API 管理。
如何管理登入狀態與憑證？
執行 `orriven logout` 可清除本機憑證。工作階段同時顯示於主控台帳號設定中，支援遠端撤銷。無操作工作階段將在 7 天後自動過期。

開始使用 CLI

安裝命令列工具，在終端機中直接管理 API 金鑰、Webhook 與請求日誌。

聯絡團隊檢視完整文件