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.

<! 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 Subcommands dashboard Flags: url port <port tui Example: restart Flags: port <port Example: serve Flags: port <port no open daemon log no recovery max restarts <n tray no tray tls cert <path tls key <path Example: stop Example: <! 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 Requires Node.js ≥22.22.2 or ≥24. Verify: 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 For a remote server: Global flags Flag Description base url <url Override server URL for this invocation api key <key Override API key for this invocation output <format Output format: table (default), json , jsonl , csv json Shorthand for output json non interactive Disable prompts — for CI / shell scripts no open Don't auto open the browser on start port <n Override default port 20128 help , h Show help for the current command version , v Print the installed version Output formats All listing commands support output : Quick start: one shot server + provider setup CLI capability skills Capability Skill Server admin + backup https://raw.githubusercontent.com/diegosouzapw/OmniRoute/main/skills/omniroute cli admin/SKILL.md Provider & key management https://raw.githubusercontent.com/diegosouzapw/OmniRoute/main/skills/omniroute cli providers/SKILL.md Cloud agents (Codex / Devin / Jules) https://raw.githubusercontent.com/diegosouzapw/OmniRoute/main/skills/omniroute cli cloud/SKILL.md Evals & benchmarking https://raw.githubusercontent.com/diegosouzapw/OmniRoute/main/skills/omniroute cli eval/SKILL.md Errors Connection refused → server not running; run omniroute or omniroute serve 401 Unauthorized → wrong or missing API key command not found: omniroute → not in PATH; check npm root g or re install doctor reports SQLite incompatible → npm rebuild better sqlite3 in the app directory Admin lifecycle Requires the omniroute CLI. See [CLI entry point skill](https://raw.githubusercontent.com/diegosouzapw/OmniRoute/main/skills/omniroute cli/SKILL.md) for install + global flags. Server lifecycle Setup & provisioning Interactive wizard Non interactive (CI / Docker) Environment variables for non interactive setup: Variable Purpose OMNIROUTE SETUP PASSWORD Admin password (≥8 chars) OMNIROUTE PROVIDER Provider id (e.g. openai , anthropic ) OMNIROUTE PROVIDER NAME Display name for the connection OMNIROUTE PROVIDER BASE URL Optional OpenAI compatible base URL override OMNIROUTE API KEY Provider API key OMNIROUTE DEFAULT MODEL Optional default model DATA DIR Override OmniRoute data directory Diagnostics Checks performed: Config, Database, Storage/encryption, Port, Node runtime, Native binary (better sqlite3), Memory, Server liveness. Exit code is non zero if any check fails — useful in CI: Backup & restore Autostart (system tray / startup) On Linux: creates a systemd user service ( ~/.config/systemd/user/omniroute.service ) and enables linger so the service can start after reboot without a graphical login; on desktop sessions it also adds an XDG autostart entry with tray . On macOS: LaunchAgent plist. On Windows: registry startup entry. Tunnels (public URL) Expose a local OmniRoute instance via a secure tunnel: The tunnel URL is printed and can be used as OMNIROUTE BASE URL from remote machines. Config & environment Recovery Use reset encrypted columns force only if STORAGE ENCRYPTION KEY was lost and you need to re enter all provider API keys. Logs Update Errors doctor shows STORAGE ENCRYPTION KEY missing → set the key in .env or run reset encrypted columns force to wipe and re enter credentials doctor reports native binary fail → npm rebuild better sqlite3 in the OmniRoute app directory tunnel create cloudflare hangs → ensure cloudflared is installed: brew install cloudflare/cloudflare/cloudflared <! skill:custom end

cli-serve