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

3.0 KiB

name, description
name description
cli-setup Run initial setup, configure global CLI settings, manage environment variables, check for updates, and configure autostart via the CLI setup and config commands.

Overview

Run initial setup, configure global CLI settings, manage environment variables, check for updates, and configure autostart via the CLI setup and config commands.

Quick install

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

Subcommands

autostart

Example:

omniroute autostart

autostart enable

Example:

omniroute autostart enable

autostart disable

Example:

omniroute autostart disable

autostart toggle

Example:

omniroute autostart toggle

autostart status

Example:

omniroute autostart status

config

Show or update CLI tool configuration

Example:

omniroute config

config list

List all CLI tools and config status

Flags:

  • --json

Example:

omniroute config list

config get <tool>

Show current config for a tool

Flags:

  • --json

Example:

omniroute config get <tool>

config set <tool>

Write config for a tool

Flags:

  • --model <model>
  • --non-interactive
  • --yes

Example:

omniroute config set <tool>

config validate <tool>

Validate config format without writing

Flags:

  • --model <model>
  • --json

Example:

omniroute config validate <tool>

config opencode

Generate OpenCode config (alias for

Flags:

  • --model <model>
  • --non-interactive
  • --yes

Example:

omniroute config opencode

config lang

Example:

omniroute config lang

config get

Flags:

  • --json

Example:

omniroute config get

config set <code>

Flags:

  • --force

Example:

omniroute config set <code>

config list

Flags:

  • --json

Example:

omniroute config list

env

Show and manage environment variables

Example:

omniroute env

env show

Show current environment variables

Flags:

  • --json

Example:

omniroute env show

env get <key>

Get a single environment variable

Example:

omniroute env get <key>

env set <key> <value>

Set an environment variable (current session only)

Example:

omniroute env set <key> <value>

setup

Flags:

  • --password <value>
  • --add-provider
  • --provider <id>
  • --provider-name <name>
  • --api-key <value>
  • --default-model <model>
  • --provider-base-url <url>
  • --test-provider
  • --non-interactive
  • --list

Example:

omniroute setup

update

Flags:

  • --check
  • --apply
  • --changelog
  • --dry-run
  • --no-backup
  • --yes

Example:

omniroute update