Notalib Flutter Readium Flutter Marionette

Flutter Marionette

Interact with a running Flutter app in debug mode using the marionette CLI.

When to Use

• Capture a screenshot to verify UI state
• Read application logs to diagnose runtime behavior
• Tap, scroll, or enter text to exercise the app
• Verify example app behavior after a code change

Setup

First time? Follow the full setup guide to instrument your app and install the MCP server. Both are pre-configured for VS Code and Claude Code.

The app must be running in debug mode. Find the VM service URI printed in the console (e.g. ws://127.0.0.1:XXXXX/ws).

Option A — Named instance (reuse across commands):

marionette register my-app ws://127.0.0.1:XXXXX/ws
marionette -i my-app <command>
marionette unregister my-app   # cleanup when done

Option B — Direct URI (one-off):

marionette --uri ws://127.0.0.1:XXXXX/ws <command>

Check registered instances and connectivity:

marionette list
marionette doctor

Taking Screenshots

marionette -i my-app take-screenshots --output ./screenshot.png
# or direct URI:
marionette --uri <ws-uri> take-screenshots --output ./screenshot.png

Multi-window apps produce numbered files: screenshot.png, screenshot_1.png, …

Getting Logs

marionette -i my-app get-logs

Interacting with the UI

# Discover what's on screen
marionette -i my-app get-interactive-elements

# Tap by key (most reliable), text, or coordinates
marionette -i my-app tap --key submit_button
marionette -i my-app tap --text "Open Book"
marionette -i my-app tap --x 100 --y 200

# Enter text
marionette -i my-app enter-text --key email_field --input "user@example.com"

# Scroll to element
marionette -i my-app scroll-to --text "Bottom Item"

# Back button
marionette -i my-app press-back-button

Hot Reload

marionette -i my-app hot-reload

Exit Codes

Tips

• Prefer --key over --text for element matching — keys are stable, text can change.
• Run get-interactive-elements first to discover available targets.
• Use --uri for one-off commands; use --instance for repeated interactions.
• If a command fails with a connection error, run marionette doctor to check all instances.

Source: Notalib/flutter_readium — distributed by TomeVault.