diff --git a/README.md b/README.md index 35f7d55170..0bc3228b2f 100644 --- a/README.md +++ b/README.md @@ -167,6 +167,16 @@ _Connect any AI-powered IDE or CLI tool through OmniRoute — free API gateway f - **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md), open a PR, or pick a `good first issue` - **Original Project**: [9router by decolua](https://github.com/decolua/9router) +### 🐛 Reporting a Bug? + +When opening an issue, please run the system-info command and attach the generated file: + +```bash +npm run system-info +``` + +This generates a `system-info.txt` with your Node.js version, OmniRoute version, OS details, installed CLI tools (iflow, gemini, claude, codex, antigravity, droid, etc.), Docker/PM2 status, and system packages — everything we need to reproduce your issue quickly. Attach the file directly to your GitHub issue. + --- ## 🔄 How It Works @@ -358,6 +368,7 @@ When a call fails, the dev doesn't know if it was a rate limit, expired token, w - **Translator Playground** — 4 debugging modes: Playground (format translation), Chat Tester (round-trip), Test Bench (batch), Live Monitor (real-time) - **Request Telemetry** — p50/p95/p99 latency + X-Request-Id tracing - **File-Based Logging with Rotation** — Console interceptor captures everything to JSON log with size-based rotation +- **System Info Report** — `npm run system-info` generates `system-info.txt` with your full environment (Node version, OmniRoute version, OS, CLI tools, Docker/PM2 status). Attach it when reporting issues for instant triage.