SuperAPI AI 工具集

omniroute-cli-admin

部署与运维

查看项目

更新于 10-22 16:16

技能介绍

OmniRoute — CLI Admin 是一个命令行管理技能,用于管理 OmniRoute 服务的生命周期与日常运维。使用前提是已安装 omniroute CLI,安装方式与全局参数见 CLI 入口点技能。

服务生命周期:直接运行 omniroute 启动服务器(默认端口 20128),serve 为显式别名;--port 可覆盖端口,--no-open 禁止自动打开浏览器,--mcp 以 MCP 服务器(stdio 传输)启动。stop 停止运行中的服务器,restart 重启,dashboard(别名 open)在浏览器打开面板,status 查看运行状态(运行时长、请求数、提供商)。

初始化与配置:omniroute setup 提供分步交互式初始化;非交互模式适用于 CI/Docker,可通过参数 --non-interactive、--password、--add-provider、--provider、--api-key、--test-provider 完成配置,也可使用环境变量 OMNIROUTE_SETUP_PASSWORD(管理员密码,≥8 字符)、OMNIROUTE_PROVIDER、OMNIROUTE_PROVIDER_NAME、OMNIROUTE_PROVIDER_BASE_URL(可选 OpenAI 兼容 base URL 覆盖)、OMNIROUTE_API_KEY、OMNIROUTE_DEFAULT_MODEL,以及 DATA_DIR(覆盖数据目录)。

诊断:omniroute doctor 执行完整健康检查,--json 输出机器可读结果,--no-liveness 跳过 HTTP 健康探测,--host 与 --liveness-url 可覆盖探测地址。检查项包括配置、数据库、存储/加密、端口、Node 运行时、原生二进制(better-sqlite3)、内存、服务器存活。任一检查失败时退出码非零,便于在 CI 中使用。

备份与恢复:omniroute backup 将配置与 SQLite 数据库快照保存到 ~/.omniroute/backups/;omniroute restore 通过交互选择从历史快照恢复。

开机自启动:autostart enable 注册为系统启动项,disable 移除,status 查看状态。Linux 下创建 systemd 用户服务并启用 linger,桌面会话额外添加带 --tray 的 XDG 自启动项;macOS 使用 LaunchAgent plist;Windows 使用注册表启动项。

隧道:tunnel list 列出活动隧道,tunnel create cloudflare(免费)/tailscale/ngrok 创建隧道,tunnel stop <id> 停止。隧道 URL 会打印,可作为远程机器的 OMNIROUTE_BASE_URL 使用。

配置与环境变量:config show 显示当前生效配置;env show 列出全部 OmniRoute 环境变量,env get <KEY> 获取单个值,env set <KEY> <value> 设置(临时,重启后失效)。

恢复操作:reset-password 交互式重置管理员密码;reset-encrypted-columns 为试运行,显示加密凭据列,加 --force 会清空 SQLite 中的加密凭据。仅在 STORAGE_ENCRYPTION_KEY 丢失、需要重新录入所有提供商 API 密钥时使用 --force。

日志与更新:logs 流式查看请求日志,--json 输出 JSON 条目,--search <term> 按词过滤,--follow 持续跟踪;update 检查新版本并提示更新。

常见错误处理:doctor 提示 STORAGE_ENCRYPTION_KEY 缺失时,在 .env 中设置该密钥,或运行 reset-encrypted-columns --force 清空并重新录入凭据;原生二进制检查失败时,在 OmniRoute 应用目录执行 npm rebuild better-sqlite3;tunnel create cloudflare 卡住时,确认已安装 cloudflared(如 brew install cloudflare/cloudflare/cloudflared)。