Getting Started

Uyava is a developer tool for Flutter that turns architecture and runtime activity into a live 2D graph. You can use it in three ways:

  • DevTools Extension (Free, open source): runs inside Flutter DevTools for live inspection.
  • Desktop App (Free): same graph with better performance, IDE integration, and basic recording + preview.
  • Desktop Pro (Paid upgrade): advanced replay controls for long sessions and deeper navigation of .uyava logs.

If you are new to Uyava, start with DevTools or the free desktop app and connect it to a running Flutter app.

Quick start for Flutter apps

  1. Add the SDK:
# pubspec.yaml
dependencies:
  uyava: ^0.0.0 # replace with the published version
  1. Initialize Uyava and send a snapshot early:
import 'package:flutter/widgets.dart';
import 'package:uyava/uyava.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  Uyava.initialize();

  Uyava.replaceGraph(
    nodes: const [
      UyavaNode(id: 'ui.login', type: 'screen', label: 'Login', tags: ['ui']),
      UyavaNode(id: 'logic.auth', type: 'service', label: 'Auth', tags: ['auth']),
    ],
    edges: const [
      UyavaEdge(id: 'ui.login->logic.auth', from: 'ui.login', to: 'logic.auth'),
    ],
  );

  runApp(const MyApp());
}
  1. Emit runtime events:
Uyava.emitNodeEvent(
  nodeId: 'logic.auth',
  message: 'Sign in pressed',
  severity: UyavaSeverity.info,
);

Uyava.emitEdgeEvent(
  edge: 'ui.login->logic.auth',
  message: 'Auth request dispatched',
  severity: UyavaSeverity.info,
);

Connect a host

  • DevTools: run your app in debug or profile, open Flutter DevTools, and select the Uyava extension tab. The extension listens to VM Service events, so it works without extra network setup.
  • Desktop: launch the desktop app and paste the VM Service URI from your running app. The desktop host mirrors the same data model as DevTools.

Next steps

  • Review the UI workflow in Quick Tour.
  • Learn how filtering affects the graph, metrics, chains, and journal.
  • If you need offline replays, read Recording and .uyava Logs.
  • For deeper API and transport details, see SDK Integration and Under the Hood.