buoy 0.3.8
buoy: ^0.3.8 copied to clipboard
Buoy tools for Flutter debug builds. Configure an account key and app integrations for in-app inspection and optional Desktop connections.
buoy #
Buoy adds developer tools to Flutter debug builds. Inspect supported requests, logs, storage, state, and performance in your app. The umbrella package registers its bundled tools; some need additional app integration.
Requirements #
Use a Flutter debug build and a Free or Pro Buoy account. You need Dart 3.9 or later, below 4.0. You also need Flutter 3.27 or later. Buoy's tools don't start in profile or release builds. That's true even with Pro.
Install and run #
flutter pub add buoy
This small app checks that Console catches logs. In your own app, keep your screens, navigator and providers. Just add the builder around their child.
import 'package:buoy/buoy.dart';
import 'package:flutter/material.dart';
void main() {
BuoyConsole.runZoned(() => runApp(const DemoApp()));
}
class DemoApp extends StatelessWidget {
const DemoApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
builder: (context, child) => BuoyDevTools(
deviceName: 'Flutter demo',
child: child ?? const SizedBox.shrink(),
),
home: Scaffold(
body: Center(
child: TextButton(
onPressed: () => print('Buoy setup check'),
child: const Text('Write a test log'),
),
),
),
);
}
}
Sign in from your app folder, then run the app:
npx --package=@buoy-gg/core buoy login
flutter run --dart-define-from-file=.env.local
buoy login writes a dev token to .env.local as BUOY_KEY. The widget reads it by itself.
Finish any account prompt. Tap Write a test log. Then open Buoy's Console and find Buoy setup check. Does the menu still ask you to sign in? Check that you ran with --dart-define-from-file=.env.local. Is Console empty? Check that the button ran inside BuoyConsole.runZoned, after Buoy let you in.
The umbrella widget registers its bundled tools. Installing an individual package requires its explicit registration call. Registration alone does not supply your app's router, provider observers, environment values, or authentication callbacks.
Tools #
| Tool | Package | App integration |
|---|---|---|
| Network | buoy_network | Supported HttpClient capture paths. |
| Storage | buoy_storage | BuoyPrefs for immediate write events; adapters for secure storage and MMKV. |
| Console | buoy_console | BuoyConsole.runZoned for print capture. |
| Env | buoy_env | Explicit configuration values and validation rules. |
| Routes | buoy_routes | Navigator observer and the existing go_router instance. |
| Images | buoy_images | BuoyImage around inspected images. |
| Impersonate | buoy_impersonate | User search, HTTP headers, backend authorization, and reset callbacks. |
| Image Overlay | buoy_image_overlay | Optional BuoyImageTarget tags; no desktop adapter. |
| Events | buoy_events | Registered, enabled source tools. |
| Riverpod | buoy_riverpod | ProviderObserver on the app’s ProviderScope. |
| Perf Monitor | buoy_perf_monitor | Open panel, HUD, or desktop watcher; platform-specific metrics. |
| Ask Buoy | buoy_ask_buoy | Pass askBuoy to BuoyDevTools. Hosted AI also needs signIn and Pro. |
Core and shared UI packages provide the registry, shell, sync client, widgets, and event stores. Flutter capabilities differ from the React Native suite; use each Flutter guide for supported behavior.
Desktop and MCP #
Open Buoy Desktop, sign in, and select the connected device. The default broker port is 42831. The iOS Simulator uses localhost; the Android emulator maps localhost to its host address. For a physical device, set socketUrl: 'http://YOUR_COMPUTER_LAN_IP:42831' on BuoyDevTools and use a network that can reach your computer.
MCP needs separate process account configuration and Pro access. Remote capabilities depend on each tool's adapter. Account validation makes network requests, and device sessions can cross your LAN. See Telemetry for data-flow details.
Accounts and plans #
Sign in with a Free or Pro account. To sign in with a code instead, pass signIn: const BuoySignIn(appId: 'com.acme.shop') to BuoyDevTools. An account key still works, with --dart-define=BUOY_KEY=YOUR_LICENSE_KEY. See pricing for capture limits and paid features. Pro does not turn on Flutter tools in profile or release builds. Your app decides which testers can see its data.
License #
Proprietary software. © Buoy LLC. See the Terms of Service and pricing.