Server Control CLI

<!-- generated by src/lib/agentSkills/generator.ts; manual edits will be overwritten -->

Overview

Start, stop, and restart the OmniRoute server from the CLI. Manage daemon mode, port configuration, auto-recovery, system tray integration, and the dashboard open shortcut.

Quick install

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

Subcommands

dashboard

Flags:

• --url
• --port <port>
• --tui

Example:

omniroute dashboard

restart

Flags:

• --port <port>

Example:

omniroute restart

serve

Flags:

• --port <port>
• --no-open
• --daemon
• --log
• --no-recovery
• --max-restarts <n>
• --headless
• --tray
• --no-tray
• --ready-timeout <ms>
• --tls-cert <path>
• --tls-key <path>

Example:

omniroute serve

stop

Flags:

• --port <port>

Example:

omniroute stop

<!-- skill:custom-start --> <!-- Aggregated from: omniroute-cli (setup + index), omniroute-cli-admin (lifecycle/setup/backup/tunnel) -->

Setup

The omniroute binary ships with the OmniRoute server. It is both the server launcher and a full management CLI with 250+ commands across 39 groups.

Install

npm install -g omniroute          # npm registry
# or: use the binary bundled with the desktop app

Requires Node.js ≥22.22.2 or ≥24.

Verify:

omniroute --version   # prints installed version
omniroute --help      # full command tree

Connection

Every CLI command that talks to the server reads two values:

Source	Variable / Flag
Base URL	OMNIROUTE_BASE_URL or --base-url
API key	OMNIROUTE_API_KEY or --api-key

Default base URL: http://localhost:20128

export OMNIROUTE_BASE_URL="http://localhost:20128"
export OMNIROUTE_API_KEY="sk-..."          # from Dashboard → API Manager