OmniRoute/docs/UNINSTALL.md

OmniRoute — Uninstall Guide

🌐 Languages: 🇺🇸 English | 🇧🇷 Português (Brasil) | 🇪🇸 Español | 🇫🇷 Français | 🇮🇹 Italiano | 🇷🇺 Русский | 🇨🇳 中文 (简体) | 🇩🇪 Deutsch | 🇮🇳 हिन्दी | 🇹🇭 ไทย | 🇺🇦 Українська | 🇸🇦 العربية | 🇯🇵 日本語 | 🇻🇳 Tiếng Việt | 🇧🇬 Български | 🇩🇰 Dansk | 🇫🇮 Suomi | 🇮🇱 עברית | 🇭🇺 Magyar | 🇮🇩 Bahasa Indonesia | 🇰🇷 한국어 | 🇲🇾 Bahasa Melayu | 🇳🇱 Nederlands | 🇳🇴 Norsk | 🇵🇹 Português (Portugal) | 🇷🇴 Română | 🇵🇱 Polski | 🇸🇰 Slovenčina | 🇸🇪 Svenska | 🇵🇭 Filipino | 🇨🇿 Čeština

This guide covers how to cleanly remove OmniRoute from your system.

---

Quick Uninstall (v3.6.2+)

OmniRoute provides two built-in scripts for clean removal:

Keep Your Data

npm run uninstall

This removes the OmniRoute application but preserves your database, configurations, API keys, and provider settings in ~/.omniroute/. Use this if you plan to reinstall later and want to keep your setup.

Full Removal

npm run uninstall:full

This removes the application and permanently erases all data:

• Database (storage.sqlite)
• Provider configurations and API keys
• Backup files
• Log files
• All files in the ~/.omniroute/ directory

⚠️ Warning: npm run uninstall:full is irreversible. All your provider connections, combos, API keys, and usage history will be permanently deleted.

---

Manual Uninstall

NPM Global Install

# Remove the global package
npm uninstall -g omniroute

# (Optional) Remove data directory
rm -rf ~/.omniroute

pnpm Global Install

pnpm uninstall -g omniroute
rm -rf ~/.omniroute

Docker

# Stop and remove the container
docker stop omniroute
docker rm omniroute

# Remove the volume (deletes all data)
docker volume rm omniroute-data

# (Optional) Remove the image
docker rmi diegosouzapw/omniroute:latest

Docker Compose

# Stop and remove containers
docker compose down

# Also remove volumes (deletes all data)
docker compose down -v

Electron Desktop App

Windows:

• Open Settings → Apps → OmniRoute → Uninstall
• Or run the NSIS uninstaller from the install directory

macOS:

• Drag OmniRoute.app from /Applications to Trash
• Remove data: rm -rf ~/Library/Application Support/omniroute

Linux:

• Remove the AppImage file
• Remove data: rm -rf ~/.omniroute

Source Install (git clone)

# Remove the cloned directory
rm -rf /path/to/omniroute

# (Optional) Remove data directory
rm -rf ~/.omniroute

---

Data Directories

OmniRoute stores data in the following locations by default:

Platform	Default Path	Override
Linux	~/.omniroute/	DATA_DIR env var
macOS	~/.omniroute/	DATA_DIR env var
Windows	%APPDATA%/omniroute/	DATA_DIR env var
Docker	/app/data/ (mounted volume)	DATA_DIR env var
XDG-compliant	$XDG_CONFIG_HOME/omniroute/	XDG_CONFIG_HOME env var

Files in the data directory

File/Directory	Description
storage.sqlite	Main database (providers, combos, settings, keys)
storage.sqlite-wal	SQLite write-ahead log (temporary)
storage.sqlite-shm	SQLite shared memory (temporary)
call_logs/	Request payload archives
backups/	Automatic database backups
log.txt	Legacy request log (optional)

---

Verify Complete Removal

After uninstalling, verify there are no remaining files:

# Check for global npm package
npm list -g omniroute 2>/dev/null

# Check for data directory
ls -la ~/.omniroute/ 2>/dev/null

# Check for running processes
pgrep -f omniroute

If any process is still running, stop it:

pkill -f omniroute