Files
2026-07-13 13:39:12 +08:00

2.4 KiB

name, description
name description
cli-keys Create, list, rotate, and revoke OmniRoute API keys from the CLI. Manage OAuth flows for provider authentication and inspect key scopes and expiration.

Overview

Create, list, rotate, and revoke OmniRoute API keys from the CLI. Manage OAuth flows for provider authentication and inspect key scopes and expiration.

Quick install

npm install -g omniroute   # or: npx omniroute
omniroute --version

Subcommands

keys

Example:

omniroute keys

keys add <provider> [apiKey]

Flags:

  • --stdin

Example:

omniroute keys add <provider> [apiKey]

keys list

Flags:

  • --json

Example:

omniroute keys list

keys remove <provider>

Flags:

  • --yes

Example:

omniroute keys remove <provider>

keys regenerate <id>

Flags:

  • --yes

Example:

omniroute keys regenerate <id>

keys revoke <id>

Flags:

  • --yes

Example:

omniroute keys revoke <id>

keys reveal <id>

Example:

omniroute keys reveal <id>

keys usage <id>

Flags:

  • --limit <n>

Example:

omniroute keys usage <id>

keys policy

Example:

omniroute keys policy

keys show <id>

Example:

omniroute keys show <id>

keys set <id>

Flags:

  • --rate-limit <n>
  • --max-cost <n>
  • --allowed-models <list>

Example:

omniroute keys set <id>

keys expiration

Example:

omniroute keys expiration

keys list

Flags:

  • --days <n>
  • --json

Example:

omniroute keys list

keys rotate <id>

Flags:

  • --grace-period <ms>
  • --yes

Example:

omniroute keys rotate <id>

oauth

Example:

omniroute oauth

oauth providers

Example:

omniroute oauth providers

oauth start

Flags:

  • --no-browser
  • --import-from-system
  • --social <s>
  • --timeout <ms>

Example:

omniroute oauth start

oauth status

Flags:

  • --provider <id>

Example:

omniroute oauth status

oauth revoke

Flags:

  • --connection-id <id>
  • --yes

Example:

omniroute oauth revoke