Skip to content

feat(docs,backup): export/import endpoints, documentation overhaul, screenshots #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
diegosouzapw merged 1 commit into from
Feb 18, 2026
Merged

feat(docs,backup): export/import endpoints, documentation overhaul, screenshots #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ docs/*
!docs/planning/
!docs/improvement-plans/
!docs/api/
!docs/VM_DEPLOYMENT_GUIDE.md
!docs/FEATURES.md
!docs/screenshots/

# open-sse tests
open-sse/test/*
Expand Down
79 changes: 66 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Access via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal...
| 🔑 **API Key Management** | Generate, rotate, and scope API keys per provider |
| 🧙 **Onboarding Wizard** | 4-step guided setup for first-time users |
| 🔧 **CLI Tools Dashboard** | One-click configure Claude, Codex, Cline, OpenClaw, Kilo, Antigravity |
| 🔄 **DB Backups** | Automatic backup and restore for all settings |
| 🔄 **DB Backups** | Automatic backup, restore, export & import for all settings |

<details>
<summary><b>📖 Feature Details</b></summary>
Expand Down Expand Up @@ -459,9 +459,16 @@ Seamless translation between formats:

### 🔧 Translator Playground

- Debug, test, and visualize API format translations
- Send requests and see how OmniRoute translates between provider formats
- Invaluable for troubleshooting integration issues
OmniRoute includes a powerful built-in Translator Playground with **4 modes** for debugging, testing, and monitoring API translations:

| Mode | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **💻 Playground** | Direct format translation — paste any API request body and instantly see how OmniRoute translates it between provider formats (OpenAI ↔ Claude ↔ Gemini ↔ Responses API). Includes example templates and format auto-detection. |
| **💬 Chat Tester** | Send real chat requests through OmniRoute and see the full round-trip: your input, the translated request, the provider response, and the translated response back. Invaluable for validating combo routing. |
| **🧪 Test Bench** | Batch testing mode — define multiple test cases with different inputs and expected outputs, run them all at once, and compare results across providers and models. |
| **📱 Live Monitor** | Real-time request monitoring — watch incoming requests as they flow through OmniRoute, see format translations happening live, and identify issues instantly. |

**Access:** Dashboard → Translator (sidebar)

### 💾 Cloud Sync

Expand Down Expand Up @@ -918,15 +925,61 @@ The pre-loaded "OmniRoute Golden Set" contains 10 test cases covering:

## 📖 Documentation

| Document | Description |
| ------------------------------------------ | ---------------------------------------------- |
| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment |
| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples |
| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions |
| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals |
| [Contributing](CONTRIBUTING.md) | Development setup and guidelines |
| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification |
| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices |
| Document | Description |
| -------------------------------------------- | ---------------------------------------------- |
| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment |
| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples |
| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions |
| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals |
| [Contributing](CONTRIBUTING.md) | Development setup and guidelines |
| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification |
| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices |
| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup |
| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots |

### 📸 Dashboard Preview

<details>
<summary><b>Click to see dashboard screenshots</b></summary>

| Page | Screenshot |
| -------------- | ------------------------------------------------- |
| **Providers** | ![Providers](docs/screenshots/01-providers.png) |
| **Combos** | ![Combos](docs/screenshots/02-combos.png) |
| **Analytics** | ![Analytics](docs/screenshots/03-analytics.png) |
| **Health** | ![Health](docs/screenshots/04-health.png) |
| **Translator** | ![Translator](docs/screenshots/05-translator.png) |
| **Settings** | ![Settings](docs/screenshots/06-settings.png) |
| **CLI Tools** | ![CLI Tools](docs/screenshots/07-cli-tools.png) |
| **Usage Logs** | ![Usage](docs/screenshots/08-usage.png) |
| **Endpoint** | ![Endpoint](docs/screenshots/09-endpoint.png) |

</details>

---

## 🗺️ Roadmap

OmniRoute has **210+ features planned** across multiple development phases. Here are the key areas:

| Category | Planned Features | Highlights |
| ----------------------------- | ---------------- | -------------------------------------------------------------------------------------- |
| 🧠 **Routing & Intelligence** | 25+ | Lowest-latency routing, tag-based routing, quota preflight, P2C account selection |
| 🔒 **Security & Compliance** | 20+ | SSRF hardening, credential cloaking, rate-limit per endpoint, management key scoping |
| 📊 **Observability** | 15+ | OpenTelemetry integration, real-time quota monitoring, cost tracking per model |
| 🔄 **Provider Integrations** | 20+ | Dynamic model registry, provider cooldowns, multi-account Codex, Copilot quota parsing |
| ⚡ **Performance** | 15+ | Dual cache layer, prompt cache, response cache, streaming keepalive, batch API |
| 🌐 **Ecosystem** | 10+ | WebSocket API, config hot-reload, distributed config store, commercial mode |

### 🔜 Coming Soon

- 🔗 **OpenCode Integration** — Native provider support for the OpenCode AI coding IDE
- 🔗 **TRAE Integration** — Full support for the TRAE AI development framework
- 📦 **Batch API** — Asynchronous batch processing for bulk requests
- 🎯 **Tag-Based Routing** — Route requests based on custom tags and metadata
- 💰 **Lowest-Cost Strategy** — Automatically select the cheapest available provider

> 📝 Full feature specifications available in [`docs/new-features/`](docs/new-features/) (217 detailed specs)

---

Expand Down
75 changes: 64 additions & 11 deletions README.pt-BR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,14 +389,14 @@ Acesso via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal...

### ☁️ Deploy e Sincronização

| Funcionalidade | O que Faz |
| --------------------------------- | -------------------------------------------------------------------------------- |
| 💾 **Cloud Sync** | Sincronize configurações entre dispositivos via Cloudflare Workers |
| 🌐 **Deploy em Qualquer Lugar** | Localhost, VPS, Docker, Cloudflare Workers |
| 🔑 **Gestão de API Keys** | Gere, rotacione e defina escopo de API keys por provedor |
| 🧙 **Assistente de Configuração** | Setup guiado em 4 etapas para novos usuários |
| 🔧 **Dashboard CLI Tools** | Configuração em um clique para Claude, Codex, Cline, OpenClaw, Kilo, Antigravity |
| 🔄 **Backups de DB** | Backup e restauração automáticos de todas as configurações |
| Funcionalidade | O que Faz |
| --------------------------------- | --------------------------------------------------------------------------------- |
| 💾 **Cloud Sync** | Sincronize configurações entre dispositivos via Cloudflare Workers |
| 🌐 **Deploy em Qualquer Lugar** | Localhost, VPS, Docker, Cloudflare Workers |
| 🔑 **Gestão de API Keys** | Gere, rotacione e defina escopo de API keys por provedor |
| 🧙 **Assistente de Configuração** | Setup guiado em 4 etapas para novos usuários |
| 🔧 **Dashboard CLI Tools** | Configuração em um clique para Claude, Codex, Cline, OpenClaw, Kilo, Antigravity |
| 🔄 **Backups de DB** | Backup, restauração, exportação e importação automática de todas as configurações |

<details>
<summary><b>📖 Detalhes das Funcionalidades</b></summary>
Expand Down Expand Up @@ -459,9 +459,16 @@ Tradução transparente entre formatos:

### 🔧 Playground do Tradutor

- Debug, teste e visualize traduções de formato de API
- Envie requisições e veja como o OmniRoute traduz entre formatos de provedores
- Inestimável para troubleshooting de problemas de integração
O OmniRoute inclui um poderoso Playground de Tradução integrado com **4 modos** para debug, teste e monitoramento de traduções de API:

| Modo | Descrição |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **💻 Playground** | Tradução direta entre formatos — cole qualquer corpo de requisição e veja instantaneamente como o OmniRoute traduz entre formatos (OpenAI ↔ Claude ↔ Gemini ↔ Responses API). Inclui templates de exemplo e auto-detecção de formato. |
| **💬 Chat Tester** | Envie requisições reais pelo OmniRoute e veja a viagem completa: sua entrada, a requisição traduzida, a resposta do provedor, e a resposta traduzida de volta. Inestimável para validar roteamento de combos. |
| **🧪 Test Bench** | Modo de teste em lote — defina múltiplos casos de teste com diferentes entradas e saídas esperadas, execute todos de uma vez, e compare resultados entre provedores e modelos. |
| **📱 Live Monitor** | Monitoramento de requisições em tempo real — acompanhe requisições entrando conforme fluem pelo OmniRoute, veja traduções de formato acontecendo ao vivo, e identifique problemas instantaneamente. |

**Acesso:** Dashboard → Translator (barra lateral)

### 💾 Cloud Sync

Expand Down Expand Up @@ -927,6 +934,52 @@ O "OmniRoute Golden Set" pré-carregado contém 10 casos de teste cobrindo:
| [Contribuindo](CONTRIBUTING.md) | Setup de desenvolvimento e diretrizes |
| [Spec OpenAPI](docs/openapi.yaml) | Especificação OpenAPI 3.0 |
| [Política de Segurança](SECURITY.md) | Reportar vulnerabilidades e práticas de segurança |
| [Deploy em VM](docs/VM_DEPLOYMENT_GUIDE.md) | Guia completo: VM + nginx + Cloudflare |
| [Galeria de Features](docs/FEATURES.md) | Tour visual do dashboard com screenshots |

### 📸 Preview do Dashboard

<details>
<summary><b>Clique para ver screenshots do dashboard</b></summary>

| Página | Screenshot |
| ----------------- | ------------------------------------------------- |
| **Provedores** | ![Providers](docs/screenshots/01-providers.png) |
| **Combos** | ![Combos](docs/screenshots/02-combos.png) |
| **Analytics** | ![Analytics](docs/screenshots/03-analytics.png) |
| **Saúde** | ![Health](docs/screenshots/04-health.png) |
| **Tradutor** | ![Translator](docs/screenshots/05-translator.png) |
| **Configurações** | ![Settings](docs/screenshots/06-settings.png) |
| **CLI Tools** | ![CLI Tools](docs/screenshots/07-cli-tools.png) |
| **Logs de Uso** | ![Usage](docs/screenshots/08-usage.png) |
| **Endpoint** | ![Endpoint](docs/screenshots/09-endpoint.png) |

</details>

---

## 🗺️ Roadmap

O OmniRoute tem **210+ funcionalidades planejadas** em múltiplas fases de desenvolvimento. Áreas principais:

| Categoria | Features Planejadas | Destaques |
| -------------------------------- | ------------------- | --------------------------------------------------------------------------- |
| 🧠 **Roteamento e Inteligência** | 25+ | Roteamento por menor latência, roteamento por tags, pré-verificação de cota |
| 🔒 **Segurança e Compliance** | 20+ | Hardening SSRF, cloaking de credenciais, rate-limit por endpoint |
| 📊 **Observabilidade** | 15+ | Integração OpenTelemetry, monitoramento de cota em tempo real |
| 🔄 **Integrações** | 20+ | Registro dinâmico de modelos, cooldowns de provedor |
| ⚡ **Performance** | 15+ | Cache dupla camada, prompt cache, response cache, batch API |
| 🌐 **Ecossistema** | 10+ | WebSocket API, config hot-reload, modo comercial |

### 🔜 Em Breve

- 🔗 **Integração com OpenCode** — Suporte nativo como provider para a IDE OpenCode
- 🔗 **Integração com TRAE** — Suporte completo ao framework de desenvolvimento TRAE
- 📦 **Batch API** — Processamento assíncrono em lote para requisições em massa
- 🎯 **Roteamento por Tags** — Roteamento de requisições baseado em tags personalizadas
- 💰 **Estratégia de Menor Custo** — Seleção automática do provedor mais barato

> 📝 Especificações completas de features disponíveis em [`docs/new-features/`](docs/new-features/) (217 specs detalhadas)

---

Expand Down
11 changes: 11 additions & 0 deletions docs/API_REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,17 @@ Response example:
| `/api/monitoring/health` | GET | Health check |
| `/api/cache` | GET/DELETE | Cache stats / clear |

### Backup & Export/Import

| Endpoint | Method | Description |
| --------------------------- | ------ | --------------------------------------- |
| `/api/db-backups` | GET | List available backups |
| `/api/db-backups` | PUT | Create a manual backup |
| `/api/db-backups` | POST | Restore from a specific backup |
| `/api/db-backups/export` | GET | Download database as .sqlite file |
| `/api/db-backups/import` | POST | Upload .sqlite file to replace database |
| `/api/db-backups/exportAll` | GET | Download full backup as .tar.gz archive |

### Cloud Sync

| Endpoint | Method | Description |
Expand Down
75 changes: 75 additions & 0 deletions docs/FEATURES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# OmniRoute — Dashboard Features Gallery

Visual guide to every section of the OmniRoute dashboard.

---

## 🔌 Providers

Manage AI provider connections: OAuth providers (Claude Code, Codex, Gemini CLI), API key providers (Groq, DeepSeek, OpenRouter), and free providers (iFlow, Qwen, Kiro).

![Providers Dashboard](screenshots/01-providers.png)

---

## 🎨 Combos

Create model routing combos with 6 strategies: fill-first, round-robin, power-of-two-choices, random, least-used, and cost-optimized. Each combo chains multiple models with automatic fallback.

![Combos Dashboard](screenshots/02-combos.png)

---

## 📊 Analytics

Comprehensive usage analytics with token consumption, cost estimates, activity heatmaps, weekly distribution charts, and per-provider breakdowns.

![Analytics Dashboard](screenshots/03-analytics.png)

---

## 🏥 System Health

Real-time monitoring: uptime, memory, version, latency percentiles (p50/p95/p99), cache statistics, and provider circuit breaker states.

![Health Dashboard](screenshots/04-health.png)

---

## 🔧 Translator Playground

Four modes for debugging API translations: **Playground** (format converter), **Chat Tester** (live requests), **Test Bench** (batch tests), and **Live Monitor** (real-time stream).

![Translator Playground](screenshots/05-translator.png)

---

## ⚙️ Settings

General settings, system storage, backup management (export/import database), appearance (dark/light mode), security, routing, resilience, and advanced configuration.

![Settings Dashboard](screenshots/06-settings.png)

---

## 🔧 CLI Tools

One-click configuration for AI coding tools: Claude Code, Codex CLI, Gemini CLI, OpenClaw, Kilo Code, and Antigravity.

![CLI Tools Dashboard](screenshots/07-cli-tools.png)

---

## 📝 Request Logs

Real-time request logging with filtering by provider, model, account, and API key. Shows status codes, token usage, latency, and response details.

![Usage Logs](screenshots/08-usage.png)

---

## 🌐 API Endpoint

Your unified API endpoint with capability breakdown: Chat Completions, Embeddings, Image Generation, Reranking, Audio Transcription, and registered API keys.

![Endpoint Dashboard](screenshots/09-endpoint.png)
Loading
Loading