mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-07-26 09:52:11 +03:00

Files

diegosouzapw 52f29f2347 fix(docs): rewrite 270 broken internal markdown links after subfolder restructure

The FASE 3 /docs restructure moved files into 8 subfolders (architecture,
guides, reference, frameworks, routing, security, compression, ops) but left
several link categories with stale relative paths. The new check:doc-links
gate (FASE 8) surfaced these and produced this exhaustive fix sweep.

Categories repaired (counts before → after, total broken: 270 → 0):

  i18n-relative (241 → 0): docs in subfolders now reference translations
    under docs/i18n/<locale>/docs/<subfolder>/<FILE>.md (one extra "../"
    plus the docs/<subfolder>/ segment). Affects ARCHITECTURE, FEATURES,
    USER_GUIDE, TROUBLESHOOTING, UNINSTALL, VM_DEPLOYMENT_GUIDE,
    API_REFERENCE, and the I18N.md self-reference table.

  parent-relative (14 → 0): refs like ../CLAUDE.md, ../CONTRIBUTING.md,
    ../AGENTS.md, ../Tuto_Qdrant.md, ../open-sse/..., ../electron/...,
    ../src/... promoted from one to two parent hops (../ → ../../) to
    reach repo root from docs/<subfolder>/.

  screenshots (9 → 0): FEATURES.md PNG refs rewritten to ../screenshots/
    (assets live at docs/screenshots/ unchanged).

  missing-rfc (2 → 0): RFC-AUTO-ASSESSMENT.md was deleted earlier in the
    overhaul; replaced refs in EVALS.md with pointers to the live
    AUTO-COMBO.md scoring doc plus an in-prose mention of
    src/domain/assessment/.

  other (4 → 0): ENVIRONMENT.md → ../../.env.example,
    SETUP_GUIDE.md → ../../{open-sse/mcp-server,src/lib/a2a}/README.md,
    PROVIDER_REFERENCE.md → ../../src/shared/... and ../../open-sse/...,
    VM_DEPLOYMENT_GUIDE.md omnirouteCloud reference replaced with a
    pointer to in-repo TUNNELS_GUIDE.md (omnirouteCloud lives in a
    separate companion repo).

Validation:
  npm run check:doc-links → PASS (501 internal links, 0 broken)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-13 19:52:04 -03:00

5.6 KiB

Raw Blame History

title, version, lastUpdated

title	version	lastUpdated
OmniRoute — Uninstall Guide	3.8.0	2026-05-13

OmniRoute — Uninstall Guide

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

5.6 KiB Raw Blame History