Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found #162281

andrewkolos · 2025-01-27T22:29:44Z

flutter doctor tells the user to install missing Android command line tools by invoking the command line tools (which are missing). Instead, let's tell the users they can install them from the website (or—more simply—download Android Studio).

Pre-launch checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

See TODO in the docs of `UserMessages`. We want to move away from using it where we can.

navaronbracke · 2025-01-28T07:02:22Z

packages/flutter_tools/test/general.shard/android/android_workflow_test.dart

    final ValidationMessage cmdlineMessage = validationResult.messages.last;
    expect(cmdlineMessage.type, ValidationMessageType.error);
-    expect(cmdlineMessage.message, errorMessage);
+    expect(cmdlineMessage.message, startsWith('cmdline-tools component is missing.\n'));


Drive-by comment, but should we also check that

https://developer.android.com/studio#command-line-tools-only and/or https://developer.android.com/studio/command-line is in the message?
And perhaps even that Run path/to/sdkmanager is not in the message.

The first phrase of the old message only differs by a period at the end, and this test doesn't test that
Run path/to/sdkmanager --install "cmdline-tools;latest"` is actually gone, which is the part we're trying to avoid here?

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

Roll Flutter from b007899 to 8e2a6fc (61 revisions) flutter/flutter@b007899...8e2a6fc 2025-02-03 [email protected] Implement hot reload using the DDC library bundle format (flutter/flutter#162498) 2025-02-01 [email protected] [Android] add lint ignores to Flutter JNI. (flutter/flutter#162527) 2025-02-01 [email protected] Fix `Linux docs_publish` running at head (flutter/flutter#162557) 2025-02-01 [email protected] [Flutter GPU] Breaking: Use exceptions for resource creation errors. (flutter/flutter#162104) 2025-02-01 [email protected] [Impeller] Increase conical gradient precision. (flutter/flutter#162543) 2025-01-31 [email protected] Roll pub packages (flutter/flutter#162542) 2025-01-31 [email protected] [web] Gracefully handle empty ui.Vertices (flutter/flutter#162461) 2025-01-31 [email protected] [web] Remove HTML build artifacts (flutter/flutter#162528) 2025-01-31 [email protected] [ Tool ] Remove use of globals from widget-preview commands (flutter/flutter#162522) 2025-01-31 [email protected] Add a special case for the Fuchsia SDK ftl.fidl file in the license script (flutter/flutter#162423) 2025-01-31 [email protected] [Impeller] Remove some unused methods from EntityPassClipStack (flutter/flutter#162478) 2025-01-31 [email protected] Reenable linux_web_engine mac tests on Mac-14 (flutter/flutter#162409) 2025-01-31 [email protected] Fix NavigationRail examples overflow alignment (flutter/flutter#159937) 2025-01-31 [email protected] Roll Skia from c1dc5033e7c9 to 4bdf90faf708 (1 revision) (flutter/flutter#162511) 2025-01-31 [email protected] Roll Skia from e0941791b86e to c1dc5033e7c9 (1 revision) (flutter/flutter#162504) 2025-01-31 [email protected] [Reland] Fix `Tab` linear and elastic animation blink (#162315) (flutter/flutter#162450) 2025-01-31 [email protected] fix syntax error in comment pseudocode (flutter/flutter#162453) 2025-01-31 [email protected] Roll Skia from ec8c632b8c7f to e0941791b86e (1 revision) (flutter/flutter#162502) 2025-01-31 [email protected] Roll Skia from a9af2a74c5ab to ec8c632b8c7f (2 revisions) (flutter/flutter#162496) 2025-01-31 [email protected] Roll pub packages (flutter/flutter#162476) 2025-01-31 [email protected] Document flutter/package deps version policy (flutter/flutter#162492) 2025-01-31 [email protected] Add iOS tool codeowner (flutter/flutter#162167) 2025-01-31 [email protected] Fixed the text aspect ratio (flutter/flutter#162415) 2025-01-31 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Delete `FlutterCommand.usageValues` (#162468)" (flutter/flutter#162494) 2025-01-31 [email protected] Add new web contributors to web triage doc. (flutter/flutter#162420) 2025-01-30 [email protected] Fix the build borked in flutter/flutter#162475. (flutter/flutter#162484) 2025-01-30 [email protected] Roll Skia from e6daf687b558 to a9af2a74c5ab (5 revisions) (flutter/flutter#162474) 2025-01-30 [email protected] Bump `Linux mac_clang_tidy" to 120m timeout (flutter/flutter#162475) 2025-01-30 [email protected] Delete `FlutterCommand.usageValues` (flutter/flutter#162468) 2025-01-30 [email protected] Fixed some floating point inaccuracies in TextContents (flutter/flutter#162351) 2025-01-30 [email protected] Limit number of retries when downloading the Dart SDK on Windows (flutter/flutter#162411) 2025-01-30 [email protected] Add FormField.errorBuilder (flutter/flutter#162255) 2025-01-30 [email protected] Fix `Checkbox` default visual density to meet Material 3 guidelines (flutter/flutter#159081) 2025-01-30 [email protected] [Android] add HC++ platform view class. (flutter/flutter#161829) 2025-01-30 [email protected] Add tests to confirm CupertinoSliverNavigationBar snaps when partially scrolled in .always bottom mode (flutter/flutter#162425) 2025-01-30 [email protected] [Impeller] Disable Vulkan on Emulators. (flutter/flutter#162454) 2025-01-30 [email protected] [FGP Kotlin conversion] Convert `Deeplink` and `IntentFilterCheck` (flutter/flutter#161835) 2025-01-30 [email protected] fix slider semantic label (flutter/flutter#162304) 2025-01-30 [email protected] Roll Skia from f22419dbed05 to e6daf687b558 (37 revisions) (flutter/flutter#162447) 2025-01-30 [email protected] Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found (flutter/flutter#162281) 2025-01-30 [email protected] remove more (simple) usage of package:usage (flutter/flutter#162354) 2025-01-30 [email protected] [Android] HC++ plumbing. (flutter/flutter#162407) 2025-01-30 [email protected] Removes dev dependencies from generated plugin registrant for non-Android platforms (flutter/flutter#161828) 2025-01-30 [email protected] Fix unexpected shown of Scrollbar (flutter/flutter#159386) 2025-01-30 [email protected] Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (flutter/flutter#162325) 2025-01-30 [email protected] Roll Fuchsia Test Scripts from r9Dc5VRF6sE3pJH20... to g6IlaYL1_wNmk3zNj... (flutter/flutter#162427) ...

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

Roll Flutter from b007899 to 8e2a6fc (61 revisions) flutter/flutter@b007899...8e2a6fc 2025-02-03 [email protected] Implement hot reload using the DDC library bundle format (flutter/flutter#162498) 2025-02-01 [email protected] [Android] add lint ignores to Flutter JNI. (flutter/flutter#162527) 2025-02-01 [email protected] Fix `Linux docs_publish` running at head (flutter/flutter#162557) 2025-02-01 [email protected] [Flutter GPU] Breaking: Use exceptions for resource creation errors. (flutter/flutter#162104) 2025-02-01 [email protected] [Impeller] Increase conical gradient precision. (flutter/flutter#162543) 2025-01-31 [email protected] Roll pub packages (flutter/flutter#162542) 2025-01-31 [email protected] [web] Gracefully handle empty ui.Vertices (flutter/flutter#162461) 2025-01-31 [email protected] [web] Remove HTML build artifacts (flutter/flutter#162528) 2025-01-31 [email protected] [ Tool ] Remove use of globals from widget-preview commands (flutter/flutter#162522) 2025-01-31 [email protected] Add a special case for the Fuchsia SDK ftl.fidl file in the license script (flutter/flutter#162423) 2025-01-31 [email protected] [Impeller] Remove some unused methods from EntityPassClipStack (flutter/flutter#162478) 2025-01-31 [email protected] Reenable linux_web_engine mac tests on Mac-14 (flutter/flutter#162409) 2025-01-31 [email protected] Fix NavigationRail examples overflow alignment (flutter/flutter#159937) 2025-01-31 [email protected] Roll Skia from c1dc5033e7c9 to 4bdf90faf708 (1 revision) (flutter/flutter#162511) 2025-01-31 [email protected] Roll Skia from e0941791b86e to c1dc5033e7c9 (1 revision) (flutter/flutter#162504) 2025-01-31 [email protected] [Reland] Fix `Tab` linear and elastic animation blink (#162315) (flutter/flutter#162450) 2025-01-31 [email protected] fix syntax error in comment pseudocode (flutter/flutter#162453) 2025-01-31 [email protected] Roll Skia from ec8c632b8c7f to e0941791b86e (1 revision) (flutter/flutter#162502) 2025-01-31 [email protected] Roll Skia from a9af2a74c5ab to ec8c632b8c7f (2 revisions) (flutter/flutter#162496) 2025-01-31 [email protected] Roll pub packages (flutter/flutter#162476) 2025-01-31 [email protected] Document flutter/package deps version policy (flutter/flutter#162492) 2025-01-31 [email protected] Add iOS tool codeowner (flutter/flutter#162167) 2025-01-31 [email protected] Fixed the text aspect ratio (flutter/flutter#162415) 2025-01-31 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Delete `FlutterCommand.usageValues` (#162468)" (flutter/flutter#162494) 2025-01-31 [email protected] Add new web contributors to web triage doc. (flutter/flutter#162420) 2025-01-30 [email protected] Fix the build borked in flutter/flutter#162475. (flutter/flutter#162484) 2025-01-30 [email protected] Roll Skia from e6daf687b558 to a9af2a74c5ab (5 revisions) (flutter/flutter#162474) 2025-01-30 [email protected] Bump `Linux mac_clang_tidy" to 120m timeout (flutter/flutter#162475) 2025-01-30 [email protected] Delete `FlutterCommand.usageValues` (flutter/flutter#162468) 2025-01-30 [email protected] Fixed some floating point inaccuracies in TextContents (flutter/flutter#162351) 2025-01-30 [email protected] Limit number of retries when downloading the Dart SDK on Windows (flutter/flutter#162411) 2025-01-30 [email protected] Add FormField.errorBuilder (flutter/flutter#162255) 2025-01-30 [email protected] Fix `Checkbox` default visual density to meet Material 3 guidelines (flutter/flutter#159081) 2025-01-30 [email protected] [Android] add HC++ platform view class. (flutter/flutter#161829) 2025-01-30 [email protected] Add tests to confirm CupertinoSliverNavigationBar snaps when partially scrolled in .always bottom mode (flutter/flutter#162425) 2025-01-30 [email protected] [Impeller] Disable Vulkan on Emulators. (flutter/flutter#162454) 2025-01-30 [email protected] [FGP Kotlin conversion] Convert `Deeplink` and `IntentFilterCheck` (flutter/flutter#161835) 2025-01-30 [email protected] fix slider semantic label (flutter/flutter#162304) 2025-01-30 [email protected] Roll Skia from f22419dbed05 to e6daf687b558 (37 revisions) (flutter/flutter#162447) 2025-01-30 [email protected] Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found (flutter/flutter#162281) 2025-01-30 [email protected] remove more (simple) usage of package:usage (flutter/flutter#162354) 2025-01-30 [email protected] [Android] HC++ plumbing. (flutter/flutter#162407) 2025-01-30 [email protected] Removes dev dependencies from generated plugin registrant for non-Android platforms (flutter/flutter#161828) 2025-01-30 [email protected] Fix unexpected shown of Scrollbar (flutter/flutter#159386) 2025-01-30 [email protected] Roll package:vm_service to 15.0.0 and package:leak_tracker to 10.0.9 (flutter/flutter#162325) 2025-01-30 [email protected] Roll Fuchsia Test Scripts from r9Dc5VRF6sE3pJH20... to g6IlaYL1_wNmk3zNj... (flutter/flutter#162427) ...

andrewkolos added 2 commits January 27, 2025 14:13

refactor: move androidMissingCmdTools out of UserMessages

65185ce

See TODO in the docs of `UserMessages`. We want to move away from using it where we can.

update message

c3e766f

andrewkolos added the tool Affects the "flutter" command-line tool. See also t: labels. label Jan 27, 2025

andrewkolos added 2 commits January 27, 2025 22:03

fix oopsie

30c74b9

Merge branch 'master' into fix-cmdline-tools-instructions

76a90fd

andrewkolos marked this pull request as ready for review January 28, 2025 06:06

andrewkolos requested a review from kenzieschmoll January 28, 2025 06:07

navaronbracke reviewed Jan 28, 2025

View reviewed changes

make test against message more precise

9c51445

andrewkolos requested a review from bkonyi January 29, 2025 21:21

bkonyi approved these changes Jan 30, 2025

View reviewed changes

andrewkolos added this pull request to the merge queue Jan 30, 2025

Merged via the queue into flutter:master with commit 5e76246 Jan 30, 2025
161 checks passed

andrewkolos deleted the fix-cmdline-tools-instructions branch January 30, 2025 19:02

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 31, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

b0dbbea

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 31, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

8b9a954

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll mentioned this pull request Feb 1, 2025

Roll Flutter from b007899d3a7a to f56d5a98c1da (59 revisions) flutter/packages#8547

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 1, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

f62931c

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll mentioned this pull request Feb 1, 2025

Roll Flutter from b007899d3a7a to f56d5a98c1da (59 revisions) flutter/packages#8548

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 1, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

97b2a3f

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll mentioned this pull request Feb 2, 2025

Roll Flutter from b007899d3a7a to 4d08217f8dca (60 revisions) flutter/packages#8549

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

44bbb14

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll mentioned this pull request Feb 2, 2025

Roll Flutter from b007899d3a7a to 4d08217f8dca (60 revisions) flutter/packages#8550

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

4727068

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll mentioned this pull request Feb 3, 2025

Roll Flutter from b007899d3a7a to 8e2a6fc3fd2c (61 revisions) flutter/packages#8554

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 3, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

52cf610

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll mentioned this pull request Feb 3, 2025

Roll Flutter from b007899d3a7a to 8e2a6fc3fd2c (61 revisions) flutter/packages#8556

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 3, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

187ee54

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

379da8b

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

d9e6789

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

5e76246 Fix flutter doctor instructions displayed when `cmdline-too…

6de78cb

…ls` (Android SDK) cannot be found (flutter/flutter#162281)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found #162281

Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found #162281

Uh oh!

andrewkolos commented Jan 27, 2025 •

edited

Loading

Uh oh!

navaronbracke Jan 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix flutter doctor instructions displayed when cmdline-tools (Android SDK) cannot be found #162281

Fix flutter doctor instructions displayed when cmdline-tools (Android SDK) cannot be found #162281

Uh oh!

Conversation

andrewkolos commented Jan 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

navaronbracke Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found #162281

Fix `flutter doctor` instructions displayed when `cmdline-tools` (Android SDK) cannot be found #162281

andrewkolos commented Jan 27, 2025 •

edited

Loading

navaronbracke Jan 28, 2025 •

edited

Loading