Skip to content

Add maui CLI reference article for .NET MAUI 11#3223

Closed
davidortinau wants to merge 3 commits intomainfrom
dotnet11-maui-cli-docs
Closed

Add maui CLI reference article for .NET MAUI 11#3223
davidortinau wants to merge 3 commits intomainfrom
dotnet11-maui-cli-docs

Conversation

@davidortinau
Copy link
Copy Markdown
Contributor

@davidortinau davidortinau commented Mar 10, 2026

Summary

New reference article documenting the maui CLI tool introduced in .NET MAUI 11 (dotnet/maui#34217, spec: dotnet/maui#33865).

New file

  • docs/get-started/maui-cli.md — Reference article covering:
    • maui doctor — environment health checks and auto-fix
    • maui android install — JDK, SDK, and emulator setup
    • maui apple install — Xcode, licenses, and iOS runtime management
    • Structured --json output for CI/CD and AI agent integration
    • Scoped to monikerRange: >=net-maui-11.0

Note

The what's-new entry for this feature is included in the companion PR #3222.


Internal previews

📄 File 🔗 Preview link
docs/get-started/maui-cli.md docs/get-started/maui-cli

New reference article for the maui CLI tool introduced in .NET 11:
- maui doctor: environment health checks and auto-fix
- maui android install: JDK, SDK, and emulator setup
- maui apple install: Xcode, licenses, and iOS runtime management
- Structured --json output for CI/CD and AI agent integration

Upstream: dotnet/maui#34217, spec PR dotnet/maui#33865

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidortinau davidortinau requested a review from a team as a code owner March 10, 2026 14:33
@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 17d7536:

✅ Validation status: passed

File Status Preview URL Details
docs/get-started/maui-cli.md ✅Succeeded View (>=net-maui-8.0)

For more details, please refer to the build report.

| Command | Description |
|---------|-------------|
| `maui android jdk check` | Check JDK installation status |
| `maui android jdk install` | Install OpenJDK (default: 17) |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the default really 17, not 21?

{
"name": "JDK",
"status": "ok",
"version": "17.0.12"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know its just a sample, but should be 21? Make it a bit more future proof?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI-guess-so?

Verify Xcode, accept the license, and install an iOS runtime:

```dotnetcli
maui apple install --accept-licenses --runtime 18.5
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: runtime 26.something that is current so its a bit more future proof?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

had it look again. The PR evidently noted 18.5 so it took that. Went with 26.2

…l options

- JDK default: 21 (not 17) per merged spec in dotnet/maui#34217
- Apple uses --accept-license (singular), not --accept-licenses
- Global option is --interactive, not --ci
- JSON example JDK version updated to 21.0.4

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 3774276:

✅ Validation status: passed

File Status Preview URL Details
docs/get-started/maui-cli.md ✅Succeeded View (>=net-maui-8.0)

For more details, please refer to the build report.

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 2bb70fc:

✅ Validation status: passed

File Status Preview URL Details
docs/get-started/maui-cli.md ✅Succeeded View (>=net-maui-8.0)

For more details, please refer to the build report.

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