Agent skill

OmniRoute Server CLI

by diegosouzapw in diegosouzapw/OmniRoute

Starts, stops and restarts the OmniRoute server from the omniroute CLI, with daemon mode, ports, TLS, auto-recovery, tray integration and a dashboard shortcut.

MITAuto-check: notesDevOps & Cloud

Install OmniRoute Server CLI

skills CLI
$ npx skills add diegosouzapw/OmniRoute --skill cli-serve -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install diegosouzapw/OmniRoute cli-serve --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/diegosouzapw/OmniRoute.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/cli-serve .claude/skills/cli-serve && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
cli-serve
GitHub stars
74k
Token cost
~2.6k tokens
SKILL.md length
504 words
Files
1
Skills in repo
50
Repo updated
First seen
Licence
MIT

At a glance

Starts, stops and restarts the OmniRoute server from the omniroute CLI, with daemon mode, ports, TLS, auto-recovery, tray integration and a dashboard shortcut.

  • Starting the OmniRoute server in the background on a chosen port
  • SKILL.md covers Overview, Quick install, Subcommands and Setup, plus 1 more section
  • Calls npm, jq and brew; needs OMNIROUTE_API_KEY and STORAGE_ENCRYPTION_KEY
  • Restarting or stopping the server after a configuration change

What it does

The omniroute binary is both the server launcher and a management CLI with 250+ commands across 39 groups. This skill covers the lifecycle ones: serve starts the server with options for port, daemon mode, logging, a restart limit, disabling auto-recovery, system tray on or off, a ready timeout and TLS certificate and key paths, stop and restart end or cycle it, and dashboard opens the web interface or prints its URL.

Setup notes say to install with npm, which needs Node.js 22.22.2 or later (or 24 and later), and to check the install with the version and help commands. Commands that talk to the server read a base URL and an API key from OMNIROUTE_BASE_URL and OMNIROUTE_API_KEY or from per-command flags. Global flags choose table, JSON, JSONL or CSV output and disable prompts for CI and shell scripts.

When your agent uses it

  • Starting the OmniRoute server in the background on a chosen port
  • Restarting or stopping the server after a configuration change
  • Running the server with TLS certificate and key files
  • Pointing CLI commands at a remote OmniRoute server

Example prompts

  • “Start the omniroute server as a daemon on port 20128 without opening the browser.”
  • “Restart omniroute and open the dashboard in the terminal interface.”
  • “Run omniroute with my TLS certificate and key, and turn off the tray icon.”

Requirements

  • Node.js 22.22.2 or later, or 24 and later
  • The omniroute package installed with npm

What it can do on your machine

Read from SKILL.md and the folder at commit f8a8131. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npm
    • jq
    • brew

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use npm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • OMNIROUTE_API_KEY
    • STORAGE_ENCRYPTION_KEY
    • OMNIROUTE_SETUP_PASSWORD

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

OmniRoute Server CLI loads about 2.6k tokens when it runs. Until then it costs about 46 tokens; SKILL.md has 504 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~46
When it runs · the whole SKILL.md, loaded when a task matches
~2.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:312
    NCRYPTION_KEY missing` → set the key in `.env` or run `reset-encrypted-columns --force` to wipe and re-enter credentials

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from diegosouzapw/OmniRoute at commit f8a8131, republished under its MIT licence (© diegosouzapw). 504 words, ~2,609 tokens.

Download SKILL.mdSave it as .claude/skills/cli-serve/SKILL.md (or your agent's skills folder).
name
cli-serve
description
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

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

Subcommands

dashboard

Flags:

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

Example:

bash
omniroute dashboard
restart

Flags:

  • --port <port>

Example:

bash
omniroute restart
serve

Flags:

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

Example:

bash
omniroute serve
stop

Example:

bash
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
bash
npm install -g omniroute          # npm registry
# or: use the binary bundled with the desktop app

Requires Node.js ≥22.22.2 or ≥24.

Verify:

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

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

SourceVariable / Flag
Base URLOMNIROUTE_BASE_URL or --base-url
API keyOMNIROUTE_API_KEY or --api-key

Default base URL: http://localhost:20128

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

For a remote server:

bash
export OMNIROUTE_BASE_URL="https://your-server.com"
Global flags
FlagDescription
--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
--jsonShorthand for --output json
--non-interactiveDisable prompts — for CI / shell scripts
--no-openDon't auto-open the browser on start
--port <n>Override default port 20128
--help, -hShow help for the current command
--version, -vPrint the installed version
Output formats

All listing commands support --output:

bash
omniroute combo list                      # human-readable table
omniroute combo list --output json        # JSON array
omniroute combo list --output jsonl       # one JSON object per line
omniroute combo list --output csv         # CSV with header row
Quick start: one-shot server + provider setup
bash
# 1. Start server
omniroute

# 2. (First run) interactive setup wizard
omniroute setup

# 3. Verify everything is healthy
omniroute doctor
CLI capability skills
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 for install + global flags.

Server lifecycle
bash
omniroute                              # Start server (default port 20128)
omniroute serve                        # Explicit alias
omniroute --port 3000                  # Override port
omniroute --no-open                    # Don't auto-open browser
omniroute --mcp                        # Start as MCP server (stdio transport)

omniroute stop                         # Stop the running server
omniroute restart                      # Restart the server

omniroute dashboard                    # Open dashboard in browser
omniroute open                         # Alias for dashboard
omniroute status                       # Runtime status (uptime, requests, providers)
Setup & provisioning
Interactive wizard
bash
omniroute setup                        # Step-by-step interactive setup
Show full SKILL.md (213 more words)Show less
Non-interactive (CI / Docker)
bash
omniroute setup --non-interactive \
  --password 'admin-password' \
  --add-provider \
  --provider openai \
  --api-key 'sk-...' \
  --test-provider

Environment variables for non-interactive setup:

VariablePurpose
OMNIROUTE_SETUP_PASSWORDAdmin password (≥8 chars)
OMNIROUTE_PROVIDERProvider id (e.g. openai, anthropic)
OMNIROUTE_PROVIDER_NAMEDisplay name for the connection
OMNIROUTE_PROVIDER_BASE_URLOptional OpenAI-compatible base URL override
OMNIROUTE_API_KEYProvider API key
OMNIROUTE_DEFAULT_MODELOptional default model
DATA_DIROverride OmniRoute data directory
Diagnostics
bash
omniroute doctor                       # Full health check
omniroute doctor --json                # Machine-readable JSON
omniroute doctor --no-liveness         # Skip HTTP health probe
omniroute doctor --host 0.0.0.0        # Override liveness host
omniroute doctor --liveness-url <url>  # Full URL override

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:

bash
omniroute doctor --json | jq '.checks[] | select(.status=="fail")'
Backup & restore
bash
omniroute backup                       # Snapshot config + SQLite DB to ~/.omniroute/backups/
omniroute restore                      # Restore from a previous snapshot (interactive picker)
Autostart (system tray / startup)
bash
omniroute autostart enable             # Register OmniRoute as a system startup item
omniroute autostart disable            # Remove startup registration
omniroute autostart status             # Show current autostart state

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:

bash
omniroute tunnel list                  # List active tunnels
omniroute tunnel create cloudflare     # Start a Cloudflare Tunnel (free)
omniroute tunnel create tailscale      # Start a Tailscale funnel
omniroute tunnel create ngrok          # Start an ngrok tunnel
omniroute tunnel stop <id>             # Stop a running tunnel

The tunnel URL is printed and can be used as OMNIROUTE_BASE_URL from remote machines.

Config & environment
bash
omniroute config show                  # Display current effective configuration
omniroute env show                     # List all OmniRoute environment variables
omniroute env get <KEY>                # Get a single env var value
omniroute env set <KEY> <value>        # Set an env var (temporary — until restart)
Recovery
bash
omniroute reset-password               # Reset the admin password interactively
omniroute reset-encrypted-columns      # Dry-run: show encrypted credential columns
omniroute reset-encrypted-columns --force  # Null out encrypted credentials in SQLite

Use reset-encrypted-columns --force only if STORAGE_ENCRYPTION_KEY was lost and you need to re-enter all provider API keys.

Logs
bash
omniroute logs                         # Stream live request logs
omniroute logs --json                  # JSON log entries
omniroute logs --search <term>         # Filter by term
omniroute logs --follow                # Tail mode (keep streaming)
Update
bash
omniroute update                       # Check for a newer version and prompt to 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 -->

© diegosouzapw, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/cli-serve of diegosouzapw/OmniRoute.

Open the folder on GitHubat commit f8a8131

Compare with similar skills

OmniRoute Server CLI next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

OmniRoute Server CLI compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
OmniRoute Server CLI this skilldiegosouzapw/OmniRoute74k—~2.6kAutomated safety check: NotesMIT
Deploying Scalable Agentsmicrosoft/ai-agents-for-beginners77k—~1.5kAutomated safety check: PassMIT
Deploying Scalable Agentsmicrosoft/ai-agents-for-beginners77k—~1.6kAutomated safety check: PassMIT
Routing Architecturemajiayu000/litellm-rs117—~1.9kAutomated safety check: PassMIT
Infrastructuretheopenco/llmgateway1.7k—~714Automated safety check: PassCustom licence
SageMaker Production Defaultshuggingface/skills11k1 repos~6.9kAutomated safety check: PassApache-2.0

Similar skills

  • Deploying Scalable Agents

    microsoft/ai-agents-for-beginners

    Official

    Take a working agent prototype to a scalable, observable production deployment on Microsoft Foundry.

    77k GitHub stars~1.5k tokensUpdated 19 days ago
    DevOps & CloudAuto-check passed
  • Deploying Scalable Agents

    microsoft/ai-agents-for-beginners

    Official

    Take one working agent prototype go scalable, observable production deployment for Microsoft Foundry.

    77k GitHub stars~1.6k tokensUpdated 19 days ago
    DevOps & CloudAuto-check passed
  • Routing Architecture

    majiayu000/litellm-rs

    LiteLLM-RS Routing Architecture. An agent skill from majiayu000/litellm-rs.

    117 GitHub stars~1.9k tokensUpdated today
    DevOps & CloudAuto-check passed
  • Infrastructure

    theopenco/llmgateway

    Production infrastructure and request-origin facts for LLM Gateway — GCP hosting, production hostnames and which app serves each, deploy ordering, client IP extraction, forwarded headers, and…

    1.7k GitHub stars~714 tokensUpdated today
    DevOps & CloudAuto-check passed
  • Official

    Deploys SageMaker endpoints with autoscaling, CloudWatch alarms and tags on by default, using scripts for real-time, scale-to-zero and async setups.

    11k GitHub starsUsed in 1 repo~6.9k tokens
    DevOps & CloudAuto-check passed
  • Azure AI Agent App Deployment

    Azure-Samples/get-started-with-ai-agents

    Official

    Creates an azd environment, checks RBAC and model quota, provisions an AI agent app on Azure with azd up and health-checks the deployed app.

    374 GitHub stars~4.7k tokensUpdated 1 mo ago
    DevOps & CloudAuto-check: notes

More from diegosouzapw/OmniRoute

All 50 skills in this repo
  • OmniRoute Backup and Sync CLI

    diegosouzapw/OmniRoute

    Backup and restore OmniRoute data from the CLI. Trigger incremental snapshots, sync to cloud storage, manage backup schedules, and restore from archive files.

    74k GitHub stars~948 tokensUpdated today
    Auto-check passed
  • OmniRoute Settings API

    diegosouzapw/OmniRoute

    Read and update global application settings: system prompts, thinking budget, IP filters, payload rules, combo defaults, and require-login configuration.

    74k GitHub starsUsed in 1 repo~3.6k tokens
    Auto-check passed
  • Quality Scan

    diegosouzapw/OmniRoute

    Runs a scoped, read-only quality scan on a repository candidate and reports exact evidence, failures and frozen debt, without treating a static scan as release acceptance.

    74k GitHub stars~748 tokensUpdated today
    Auto-check passed
  • OmniRoute Database Backups

    diegosouzapw/OmniRoute

    Trigger system backups, restore from backup files, and manage the SQLite database lifecycle. Supports export, import, and incremental snapshot strategies.

    74k GitHub starsUsed in 1 repo~395 tokens
    Auto-check passed
  • OmniRoute Provider Management

    diegosouzapw/OmniRoute

    Manages AI provider connections, API keys, OAuth flows and connection tests through OmniRoute's REST API across its 327-provider catalog.

    74k GitHub stars~2.4k tokensUpdated today
    Auto-check passed
  • OmniRoute Prompt Compression CLI

    diegosouzapw/OmniRoute

    Configure and test prompt compression from the CLI. Manage RTK filters, Caveman rules, stacked compression modes, and preview compression output with real…

    74k GitHub starsUsed in 1 repo~521 tokens
    Auto-check passed

Questions about OmniRoute Server CLI

What does OmniRoute Server CLI do?

Starts, stops and restarts the OmniRoute server from the omniroute CLI, with daemon mode, ports, TLS, auto-recovery, tray integration and a dashboard shortcut. The omniroute binary is both the server launcher and a management CLI with 250+ commands across 39 groups. This skill covers the lifecycle ones: serve starts the server with options for port, daemon mode, logging, a restart limit, disabling auto-recovery, system tray on or off, a ready timeout and TLS certificate and key paths, stop and restart end or cycle it, and dashboard opens the web interface or prints its URL.

When should I use OmniRoute Server CLI?

OmniRoute Server CLI fits situations like: starting the OmniRoute server in the background on a chosen port; restarting or stopping the server after a configuration change; running the server with TLS certificate and key files; pointing CLI commands at a remote OmniRoute server.

How do I install OmniRoute Server CLI in Claude Code?

Run `npx skills add diegosouzapw/OmniRoute --skill cli-serve -a claude-code`. Or copy the skill folder (skills/cli-serve in diegosouzapw/OmniRoute) into .claude/skills/cli-serve in your project. Claude Code loads it when a task matches its description.

How do I install OmniRoute Server CLI in Codex?

Run `npx skills add diegosouzapw/OmniRoute --skill cli-serve -a codex`. Or copy the skill folder (skills/cli-serve in diegosouzapw/OmniRoute) into .agents/skills/cli-serve in your project. Codex loads it when a task matches its description.

Can I use OmniRoute Server CLI in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add diegosouzapw/OmniRoute --skill cli-serve -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/cli-serve, .gemini/skills/cli-serve, .github/skills/cli-serve and .opencode/skills/cli-serve in your project.

What does OmniRoute Server CLI need to run?

Going by SKILL.md and its folder, OmniRoute Server CLI needs the command-line tools its instructions call (npm, jq and brew) and credentials named OMNIROUTE_API_KEY, STORAGE_ENCRYPTION_KEY and OMNIROUTE_SETUP_PASSWORD. Our summary lists: Node.js 22.22.2 or later, or 24 and later; The omniroute package installed with npm.

Does OmniRoute Server CLI access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is OmniRoute Server CLI safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does OmniRoute Server CLI use?

OmniRoute Server CLI is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does OmniRoute Server CLI use?

About 2.6k tokens (SKILL.md is roughly 10k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to OmniRoute Server CLI?

Skills that share tags, products or a category with OmniRoute Server CLI: Deploying Scalable Agents (microsoft/ai-agents-for-beginners, 77k stars), Deploying Scalable Agents (microsoft/ai-agents-for-beginners, 77k stars), Routing Architecture (majiayu000/litellm-rs, 117 stars) and Infrastructure (theopenco/llmgateway, 1.7k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains OmniRoute Server CLI?

diegosouzapw (a GitHub user) maintains it in diegosouzapw/OmniRoute, which has 74,003 GitHub stars. The repository holds 50 skills in this directory. The repository was last updated on October 8, 2026.

Source: diegosouzapw/OmniRoute on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.