Omega Flutter

Appearance

Inspector & VM Service ​

During debug, Omega can surface live channel traffic, flow snapshots, and quick JSON views of payloads — without shipping that UI to production. Three integration patterns are common; pick one or combine them.

1. In-app overlay ​

Embed OmegaInspector (e.g. in a Stack) so developers can expand/collapse a panel over the running app. Guard with kDebugMode so release builds stay lean.

2. Launcher (dialog or extra window) ​

OmegaInspectorLauncher in an AppBar opens the inspector in a dialog (desktop/mobile) or a new browser tab on web (query flag pattern). Same kDebugMode guard.

3. Browser + VM Service (desktop / mobile) ​

OmegaInspectorServer starts a small HTTP/WebSocket server; the console prints a URL (often http://localhost:9292) that loads the hosted inspector page and connects to your running VM.

CLI shortcut — paste the VM Service URL from flutter run:

bash
dart run omega_architecture:omega inspector

Hosted static page ​

The canonical URL opened by OmegaInspectorServer and omega inspector is https://yefersonsegura.com/projects/omega/inspector.html (VM Service connection uses the URL hash with the encoded VM URI). The same inspector.html file ships in this repo under docs/public/ and is also published with the VitePress site at /inspector.html on GitHub Pages for offline browsing of the UI.

Security & production ​

  • Treat VM Service URLs like debug secrets — do not expose them on untrusted networks.
  • Keep inspector widgets and servers behind kDebugMode (or a compile-time flag).
  • On web, OmegaInspectorServer is a stub — use the multi-window / receiver pattern from the package API docs instead.
  • Omega CLI — omega inspector flags
  • Time travel — recorded sessions complement the inspector
  • Observability & statistics — metrics mindset, intent→expression, what to measure
  • example/lib/main.dart — overlay + launcher + server wiring