用途
cli-keys 用于在命令行中管理 OmniRoute 的 API 密钥与服务商认证。根据资料,它支持创建、列出、轮换和吊销 OmniRoute API 密钥,并可管理用于服务商认证的 OAuth 流程,以及检查密钥的作用域和过期情况。
安装
npm install -g omniroute # or: npx omniroute
omniroute --version
主要能力
keys 命令组
keys:基础命令,示例omniroute keys。keys add <provider> [apiKey]:添加密钥,支持标志--stdin。keys list:列出密钥,支持标志--json。keys remove <provider>:移除指定服务商的密钥,支持标志--yes。keys regenerate <id>:重新生成密钥,支持标志--yes。keys revoke <id>:吊销密钥,支持标志--yes。keys reveal <id>:显示密钥内容。keys usage <id>:查询密钥用量,支持标志--limit <n>。keys policy:查看策略。keys show <id>:查看指定密钥详情。keys set <id>:设置密钥参数,支持标志--rate-limit <n>、--max-cost <n>、--allowed-models <list>。keys expiration:查看过期信息。keys list:按天数与 JSON 输出列出,支持标志--days <n>、--json。keys rotate <id>:轮换密钥,支持标志--grace-period <ms>、--yes。
oauth 命令组
oauth:基础命令,示例omniroute oauth。oauth providers:列出服务商。oauth start:发起授权,支持标志--provider <id>、--no-browser、--import-from-system、--social <s>、--timeout <ms>。oauth status:查看授权状态,支持标志--provider <id>。oauth revoke:吊销授权,支持标志--provider <id>、--connection-id <id>、--yes。
使用方式
先通过 npm 安装或使用 npx 运行,确认版本后调用对应子命令。密钥相关的增删改查、轮换与策略配置通过 keys 系列子命令完成;服务商认证通过 oauth 系列子命令完成。多数破坏性操作(移除、重新生成、吊销、轮换、OAuth 吊销)提供 --yes 标志以跳过确认,keys list 与相关命令支持 --json 输出以便脚本处理。
适用场景
适合需要在命令行或自动化脚本中集中管理 API 密钥生命周期、配置密钥速率与成本限制、限制可用模型,以及统一处理多服务商 OAuth 认证的开发与运维工作。
限制
资料未说明所支持的具体服务商范围、密钥存储位置、安全模型、是否需要额外账号或订阅、价格与配额等信息,暂未提供。