Simplify README install guidance #210
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,29 +4,61 @@ A comprehensive testing, automation, and debugging toolkit for .NET MAUI applica | |
|
|
||
| > ⚠️ **Experimental** — APIs may change between releases. Not covered by the Microsoft Support Policy. | ||
|
|
||
| ## Fastest path | ||
|
|
||
| Install the unified `maui` CLI and initialize the bundled DevFlow skills in your app workspace: | ||
|
|
||
| ```bash | ||
| dotnet tool install -g Microsoft.Maui.Cli --prerelease | ||
| maui devflow init | ||
| ``` | ||
|
|
||
| Add the in-app agent package to the MAUI app you want to automate: | ||
|
|
||
| ```bash | ||
| dotnet add package Microsoft.Maui.DevFlow.Agent --prerelease | ||
|
|
||
| # Blazor Hybrid apps only | ||
| dotnet add package Microsoft.Maui.DevFlow.Blazor --prerelease | ||
| ``` | ||
|
|
||
| Register the agent in `MauiProgram.cs` for debug builds: | ||
|
|
||
| ```csharp | ||
| using Microsoft.Maui.DevFlow.Agent; | ||
|
|
||
| public static MauiApp CreateMauiApp() | ||
| { | ||
| var builder = MauiApp.CreateBuilder(); | ||
| builder.UseMauiApp<App>(); | ||
|
|
||
| #if DEBUG | ||
| builder.AddMauiDevFlowAgent(); | ||
| #endif | ||
|
|
||
| return builder.Build(); | ||
| } | ||
| ``` | ||
|
|
||
| Run your app, then connect to it: | ||
|
|
||
| ```bash | ||
| maui devflow wait | ||
| maui devflow ui tree | ||
| maui devflow ui screenshot -o screenshot.png | ||
| maui devflow mcp | ||
| ``` | ||
|
|
||
| ## Manual setup details | ||
|
|
||
| ### NuGet package references | ||
|
|
||
| ```xml | ||
| <PackageReference Include="Microsoft.Maui.DevFlow.Agent" /> | ||
| <PackageReference Include="Microsoft.Maui.DevFlow.Blazor" /> <!-- If using Blazor Hybrid --> | ||
| ``` | ||
|
|
||
| ### MauiProgram.cs registration | ||
|
|
||
| ```csharp | ||
| using Microsoft.Maui.DevFlow.Agent; | ||
|
|
@@ -44,18 +76,17 @@ public static MauiApp CreateMauiApp() | |
| } | ||
|
Contributor
There was a problem hiding this comment. 🟢 MINOR · 2/3 consensus (after follow-up) This |
||
| ``` | ||
|
|
||
| ### CLI installation | ||
|
|
||
| ```bash | ||
| dotnet tool install -g Microsoft.Maui.Cli --prerelease | ||
| ``` | ||
|
|
||
| ### Common commands | ||
|
|
||
| ```bash | ||
| # Install DevFlow skills for AI agent integration (auto-detects target directory; | ||
| # defaults to .claude/skills/ — configurable via --target: claude, github, agent, agents, or auto) | ||
| maui devflow init | ||
|
|
||
| # Visual tree | ||
|
|
@@ -71,6 +102,19 @@ maui devflow ui tap --automationid "MyButton" | |
| maui devflow mcp | ||
| ``` | ||
|
|
||
| ## Packages | ||
|
|
||
| | Package | Description | | ||
| |---------|-------------| | ||
| | **Microsoft.Maui.DevFlow.Agent** | In-app agent for .NET MAUI apps. Exposes visual tree, element interactions, screenshots, and profiling via HTTP/JSON API. | | ||
| | **Microsoft.Maui.DevFlow.Agent.Core** | Platform-agnostic core: HTTP server, visual tree walker, CSS selector engine, network capture, profiling. | | ||
| | **Microsoft.Maui.DevFlow.Agent.Gtk** | GTK/Linux agent for Maui.Gtk apps. | | ||
| | **Microsoft.Maui.DevFlow.Blazor** | Blazor WebView CDP bridge. Enables Chrome DevTools Protocol access for Blazor Hybrid content via Chobitsu. | | ||
| | **Microsoft.Maui.DevFlow.Blazor.Gtk** | Blazor CDP bridge for WebKitGTK on Linux. | | ||
| | **Microsoft.Maui.DevFlow.CLI** | DevFlow command implementation used by the unified `maui devflow` CLI surface for automation, debugging, and MCP server support. | | ||
| | **Microsoft.Maui.DevFlow.Driver** | Platform-aware app driver for iOS, Android, Mac Catalyst, Windows, and Linux. | | ||
| | **Microsoft.Maui.DevFlow.Logging** | Buffered rotating JSONL file logger. No MAUI dependency. | | ||
|
|
||
| ### Session identity | ||
|
|
||
| When `Microsoft.Maui.DevFlow.Agent` is referenced, builds are tagged with a **session identity** | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 MODERATE · 2/3 consensus
-ois not a registered alias for the--outputoption onmaui devflow ui screenshot(only--outputis defined inDevFlowCommands.cs). A user copying this verbatim will get a parse error.