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 与请求日志。

联系团队查看完整文档