Getting Started

Flutternaut is an AI-powered end-to-end testing engine for Flutter apps. It runs your tests on real Android and iOS devices through Appium — no test code to write.

How it works

The workflow has three steps:

1

Instrument

Wrap your Flutter widgets with the flutternaut package to make them discoverable by the test engine.

2

Generate Keys

Run flutternaut_generator to extract all element labels into a JSON file for AI test authoring.

3

Run Tests

Use the desktop app to create, run, and manage tests on emulators, simulators, or physical devices.

Quick start

1. Add the package

yaml
dependencies:
  flutternaut: ^0.0.1

2. Wrap your widgets

dart
import 'package:flutternaut/flutternaut.dart';

// Button
Flutternaut.button(
  label: 'login_button',
  child: ElevatedButton(onPressed: _login, child: Text('Login')),
)

// Text input
Flutternaut.input(
  label: 'email_input',
  child: TextField(controller: _emailController),
)

3. Generate keys

bash
dart pub add --dev flutternaut_generator
dart run flutternaut_generator

4. Download the desktop app

Download Flutternaut for macOS or Windows, launch it, and start running tests.

Next steps