Skip to content

[docs] Add concise maui CLI command reference#34217

Merged
rmarinho merged 1 commit intomainfrom
docs/maui-cli-spec-summary
Feb 26, 2026
Merged

[docs] Add concise maui CLI command reference#34217
rmarinho merged 1 commit intomainfrom
docs/maui-cli-spec-summary

Conversation

@rmarinho
Copy link
Copy Markdown
Member

@rmarinho rmarinho commented Feb 24, 2026 •
edited
Loading

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Summary

Adds a concise command reference for the maui CLI — focused on Android, Apple/iOS, and --version. This is a quick-review companion to the full specification in PR #33865.

What this covers

  • maui --version
  • All maui android subcommands (install, jdk, sdk, emulator)
  • All maui apple subcommands (install, check, xcode, simulator, runtime)
  • Global options (--json, --verbose, --interactive, --dry-run)

Key design points

  • Delegate to native toolchains — wraps sdkmanager, adb, xcrun simctl, etc.
  • Reuse shared libraries — leverages dotnet/android-tools for SDK/JDK discovery and installation
  • Machine-first output — every command supports --json
  • Interactive detection — follows dotnet CLI pattern (auto-detects CI via env vars, checks Console.IsOutputRedirected)

What this intentionally omits

  • Device listing (covered by dotnet run --list-devices)
  • Install path defaults (handled by dotnet/android-tools)
  • Windows commands (see full spec)
  • Architecture, error contracts, JSON schemas, IDE integration, elevation model

All omitted details are in the full specification (PR #33865).

Copilot AI review requested due to automatic review settings February 24, 2026 20:05

This comment was marked as outdated.

Sign in to view

@rmarinho rmarinho added area-docs Conceptual docs, API docs, Samples copilot labels Feb 24, 2026
Redth
Redth reviewed Feb 24, 2026
View reviewed changes
Redth
Redth reviewed Feb 24, 2026
View reviewed changes
Redth
Redth reviewed Feb 24, 2026
View reviewed changes
Redth
Redth reviewed Feb 24, 2026
View reviewed changes
Redth
Redth reviewed Feb 24, 2026
View reviewed changes
jonathanpeppers
jonathanpeppers reviewed Feb 24, 2026
View reviewed changes
jonathanpeppers
jonathanpeppers reviewed Feb 24, 2026
View reviewed changes
rolfbjarne
rolfbjarne requested changes Feb 25, 2026
View reviewed changes
jonathanpeppers
jonathanpeppers reviewed Feb 25, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@jonathanpeppers jonathanpeppers left a comment

Choose a reason for hiding this comment

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

Should this PR delete this file, or merge the two files into one?

rolfbjarne
rolfbjarne reviewed Feb 25, 2026
View reviewed changes
@rmarinho rmarinho force-pushed the docs/maui-cli-spec-summary branch from 04329cc to 1a61bc0 Compare February 25, 2026 20:28
@rmarinho rmarinho force-pushed the docs/maui-cli-spec-summary branch 3 times, most recently from bb3d909 to d55f544 Compare February 25, 2026 20:54
@rmarinho rmarinho requested a review from Copilot February 25, 2026 23:20
rolfbjarne
rolfbjarne previously approved these changes Feb 26, 2026
View reviewed changes
@rmarinho rmarinho force-pushed the docs/maui-cli-spec-summary branch from 9f47f1a to ee85f1d Compare February 26, 2026 14:23
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 26, 2026 •
edited
Loading

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.sh | bash -s -- 34217

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.ps1) } 34217"

@rmarinho rmarinho force-pushed the docs/maui-cli-spec-summary branch from ee85f1d to afdc946 Compare February 26, 2026 14:28
This was referenced Feb 26, 2026
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@rmarinho
Add maui CLI design document with environment setup commands
00577ad 
Extends docs/design/cli.md with environment setup commands for Android
(SDK/JDK/emulator) and Apple (Xcode/simulator/runtime), global options
(--json, --interactive, --dry-run), platform filter values, and
implementation references to dotnet/android-tools.

Full specification: PR #33865

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rmarinho rmarinho force-pushed the docs/maui-cli-spec-summary branch from afdc946 to 00577ad Compare February 26, 2026 15:25
@rmarinho rmarinho mentioned this pull request Feb 26, 2026
Merged
@rmarinho rmarinho merged commit e6bb31a into main Feb 26, 2026
5 of 6 checks passed
@rmarinho rmarinho deleted the docs/maui-cli-spec-summary branch February 26, 2026 17:14
rmarinho added a commit that referenced this pull request Feb 26, 2026
@rmarinho
Sync full spec with merged summary spec (PR #34217)
67450cc 
- Move device list, screenshot, logs to vNext
- Update IDE integration: VS consumes android-tools NuGet directly
- Remove runtime list --available (can't enumerate downloadable runtimes)
- Replace maui doctor --json IDE reference with specific check commands

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Feb 28, 2026
Closed
Closed
Closed
Tamilarasan-Paranthaman pushed a commit that referenced this pull request Mar 2, 2026
@rmarinho @Tamilarasan-Paranthaman
[docs] Add concise maui CLI command reference (#34217)
2107e28 
> [!NOTE]
> Are you waiting for the changes in this PR to be merged?
> It would be very helpful if you could [test the resulting
artifacts](https://github.com/dotnet/maui/wiki/Testing-PR-Builds) from
this PR and let us know in a comment if this change resolves your issue.
Thank you!

## Summary

Adds a concise command reference for the `maui` CLI — focused on
**Android**, **Apple/iOS**, and `--version`. This is a quick-review
companion to the full specification in [PR
#33865](#33865).

### What this covers

- `maui --version`
- All `maui android` subcommands (install, jdk, sdk, emulator)
- All `maui apple` subcommands (install, check, xcode, simulator,
runtime)
- Global options (`--json`, `--verbose`, `--interactive`, `--dry-run`)

### Key design points

- **Delegate to native toolchains** — wraps `sdkmanager`, `adb`, `xcrun
simctl`, etc.
- **Reuse shared libraries** — leverages
[`dotnet/android-tools`](https://github.com/dotnet/android-tools) for
SDK/JDK discovery and installation
- **Machine-first output** — every command supports `--json`
- **Interactive detection** — follows `dotnet` CLI pattern (auto-detects
CI via env vars, checks `Console.IsOutputRedirected`)

### What this intentionally omits

- Device listing (covered by `dotnet run --list-devices`)
- Install path defaults (handled by `dotnet/android-tools`)
- Windows commands (see full spec)
- Architecture, error contracts, JSON schemas, IDE integration,
elevation model

All omitted details are in the [full specification (PR
#33865)](#33865).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rmarinho rmarinho mentioned this pull request Mar 3, 2026
Closed
davidortinau added a commit to dotnet/docs-maui that referenced this pull request Mar 10, 2026
@davidortinau
Add maui CLI reference article for .NET MAUI 11 (.NET 11)
17d7536 
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 mentioned this pull request Mar 10, 2026
Closed
davidortinau added a commit to dotnet/docs-maui that referenced this pull request Mar 10, 2026
@davidortinau
Fix JDK version (21 not 17), Apple license flag (singular), and globa…
3774276 
…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>
@github-actions github-actions bot locked and limited conversation to collaborators Mar 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@jonathanpeppers jonathanpeppers jonathanpeppers approved these changes

@PureWeen PureWeen Awaiting requested review from PureWeen

@Redth Redth Awaiting requested review from Redth

@rolfbjarne rolfbjarne Awaiting requested review from rolfbjarne

Assignees

No one assigned

Labels

area-docs Conceptual docs, API docs, Samples copilot

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@rmarinho @rolfbjarne @Redth @jonathanpeppers