Skip to content

Developer tools (experimental): CLI and DevFlow documentation#3277

Merged
davidortinau merged 3 commits intomainfrom
pr-developer-tools-cli-devflow-from-main
Apr 9, 2026
Merged

Developer tools (experimental): CLI and DevFlow documentation#3277
davidortinau merged 3 commits intomainfrom
pr-developer-tools-cli-devflow-from-main

Conversation

@jfversluis
Copy link
Copy Markdown
Member

@jfversluis jfversluis commented Apr 3, 2026

Summary

Adds a new Developer tools (experimental) section to the .NET MAUI docs, covering the CLI and DevFlow toolkit from dotnet/maui-labs.

.NET 10 change and motivation

The dotnet/maui-labs repository provides experimental developer tooling for .NET MAUI:

  • CLI (maui command) - environment diagnostics, Android SDK/JDK/emulator management, device listing
  • DevFlow - in-app testing/automation agent, visual tree inspection, screenshots, element interaction, Blazor WebView CDP debugging, MCP server for AI agents, broker for multi-app coordination

These tools have no documentation presence in the official docs today. This PR adds comprehensive coverage with clear experimental/support disclaimers on every page.

Files changed (16)

TOC

  • docs/TOC.yml - new section after Deployment and testing

Section overview (1 page)

  • docs/developer-tools/index.md - landing page with CLI/DevFlow intro, package table

CLI docs (4 pages)

  • docs/developer-tools/cli/index.md - installation, 17-command reference, global options
  • docs/developer-tools/cli/environment-diagnostics.md - maui doctor with auto-fix and CI usage
  • docs/developer-tools/cli/android-management.md - SDK, JDK, emulator management
  • docs/developer-tools/cli/device-management.md - cross-platform device listing

DevFlow docs (10 pages)

  • docs/developer-tools/devflow/index.md - architecture, quick start, packages, platform support
  • docs/developer-tools/devflow/visual-tree-screenshots.md - tree dump, CSS selectors, screenshots
  • docs/developer-tools/devflow/element-interaction.md - tap, fill, scroll, navigate, property mutation
  • docs/developer-tools/devflow/blazor-cdp.md - Chobitsu CDP bridge for Blazor Hybrid
  • docs/developer-tools/devflow/mcp-server.md - 15 MCP tool categories, AI agent config
  • docs/developer-tools/devflow/network-profiling.md - HTTP interception, perf profiling
  • docs/developer-tools/devflow/broker.md - port assignment, agent discovery, lifecycle, fallbacks
  • docs/developer-tools/devflow/setup-android.md - ADB, ChromeDriver, WebView debugging
  • docs/developer-tools/devflow/setup-apple.md - Appium, XCUITest, WKWebView inspection
  • docs/developer-tools/devflow/setup-windows.md - EdgeDriver, WebView2, remote debugging

Support policy

Every page includes a prominent IMPORTANT disclaimer noting these packages are experimental from dotnet/maui-labs and are not covered by the .NET MAUI Support Policy.

Platform notes

  • CLI: macOS, Windows, Linux (all supported)
  • DevFlow Agent: Mac Catalyst, iOS Simulator, Linux/GTK (supported); Android, Windows (in progress)

Verification

  • Content sourced from dotnet/maui-labs READMEs, docs, and source code
  • All 48 cross-links between pages validated
  • YAML front matter verified on all 15 new pages

Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/developer-tools/cli/android-management.md docs/developer-tools/cli/android-management
docs/developer-tools/cli/device-management.md docs/developer-tools/cli/device-management
docs/developer-tools/cli/environment-diagnostics.md docs/developer-tools/cli/environment-diagnostics
docs/developer-tools/cli/index.md docs/developer-tools/cli/index
docs/developer-tools/devflow/blazor-cdp.md docs/developer-tools/devflow/blazor-cdp
docs/developer-tools/devflow/broker.md docs/developer-tools/devflow/broker
docs/developer-tools/devflow/element-interaction.md docs/developer-tools/devflow/element-interaction
docs/developer-tools/devflow/index.md docs/developer-tools/devflow/index
docs/developer-tools/devflow/mcp-server.md docs/developer-tools/devflow/mcp-server
docs/developer-tools/devflow/network-profiling.md docs/developer-tools/devflow/network-profiling
docs/developer-tools/devflow/setup-android.md docs/developer-tools/devflow/setup-android
docs/developer-tools/devflow/setup-apple.md docs/developer-tools/devflow/setup-apple
docs/developer-tools/devflow/setup-windows.md docs/developer-tools/devflow/setup-windows
docs/developer-tools/devflow/visual-tree-screenshots.md docs/developer-tools/devflow/visual-tree-screenshots
docs/developer-tools/index.md docs/developer-tools/index

Add new 'Developer tools (experimental)' section documenting the
.NET MAUI CLI and DevFlow toolkit from dotnet/maui-labs.

CLI docs (4 pages):
- Overview with installation, command reference, global options
- Environment diagnostics (maui doctor)
- Android SDK, JDK, and emulator management
- Device management

DevFlow docs (10 pages):
- Overview with architecture, quick start, packages, platform support
- Visual tree inspection and screenshots
- Element interaction and automation
- Blazor WebView debugging via CDP
- MCP server for AI agents (15 tool categories)
- Network monitoring and profiling
- Broker architecture (multi-app port assignment)
- Platform setup: Android, Apple, Windows

Every page includes a prominent experimental support disclaimer
noting these packages are not covered by the .NET MAUI Support Policy.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jfversluis jfversluis requested a review from a team as a code owner April 3, 2026 12:20
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 9e31566:

💡 Validation status: suggestions

File Status Preview URL Details
docs/developer-tools/devflow/blazor-cdp.md 💡Suggestion View (>=net-maui-8.0) Details
docs/developer-tools/cli/android-management.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/device-management.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/environment-diagnostics.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/broker.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/element-interaction.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/mcp-server.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/network-profiling.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-android.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-apple.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-windows.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/visual-tree-screenshots.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/index.md ✅Succeeded View (>=net-maui-8.0)
docs/TOC.yml ✅Succeeded View (>=net-maui-8.0)

docs/developer-tools/devflow/blazor-cdp.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit e64a588:

💡 Validation status: suggestions

File Status Preview URL Details
docs/developer-tools/devflow/blazor-cdp.md 💡Suggestion View (>=net-maui-8.0) Details
docs/developer-tools/cli/android-management.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/device-management.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/environment-diagnostics.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/broker.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/element-interaction.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/mcp-server.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/network-profiling.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-android.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-apple.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-windows.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/visual-tree-screenshots.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/index.md ✅Succeeded View (>=net-maui-8.0)
docs/TOC.yml ✅Succeeded View (>=net-maui-8.0)

docs/developer-tools/devflow/blazor-cdp.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@davidortinau
Copy link
Copy Markdown
Contributor

Applied the review suggestions throughout the developer tools docs: removed redundant '(experimental)' from titles/headings, simplified the experimental disclaimer language, and tightened the overview/support wording for a more direct Learn-style read. Resolving the addressed threads.

Comment thread docs/developer-tools/index.md Outdated
Comment thread docs/developer-tools/index.md Outdated
Comment thread docs/developer-tools/index.md Outdated
Comment thread docs/developer-tools/index.md Outdated
Comment thread docs/developer-tools/index.md Outdated
Comment thread docs/developer-tools/cli/device-management.md Outdated
Comment thread docs/developer-tools/cli/device-management.md Outdated
Comment thread docs/developer-tools/cli/environment-diagnostics.md Outdated
Comment thread docs/developer-tools/cli/environment-diagnostics.md Outdated
Comment thread docs/developer-tools/cli/environment-diagnostics.md Outdated
@davidortinau davidortinau enabled auto-merge (squash) April 9, 2026 13:53
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit c0092fc:

💡 Validation status: suggestions

File Status Preview URL Details
docs/developer-tools/devflow/blazor-cdp.md 💡Suggestion View (>=net-maui-8.0) Details
docs/developer-tools/cli/android-management.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/device-management.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/environment-diagnostics.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/cli/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/broker.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/element-interaction.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/mcp-server.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/network-profiling.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-android.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-apple.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/setup-windows.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/devflow/visual-tree-screenshots.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/index.md ✅Succeeded View (>=net-maui-8.0)
docs/TOC.yml ✅Succeeded View (>=net-maui-8.0)

docs/developer-tools/devflow/blazor-cdp.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@davidortinau davidortinau merged commit 1705162 into main Apr 9, 2026
6 checks passed
@davidortinau davidortinau deleted the pr-developer-tools-cli-devflow-from-main branch April 9, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants