Skip to content

some cleanup to the CLI UI - #3129

Merged
devoncarew merged 4 commits into
flutter:masterfrom
devoncarew:cleanup_cli_args
Jun 18, 2021
Merged

devoncarew merged 4 commits into
flutter:masterfrom
devoncarew:cleanup_cli_args

Conversation

@devoncarew

Copy link
Copy Markdown
Contributor
  • some cleanup to the CLI UI

Here's the new output:

usage: devtools <options> [service protocol uri]

Open a DevTools instance in a browser and optionally connect to an existing application.

-h, --help                            Prints help output.
-v, --verbose                         Output more informational messages.
    --host=<host>                     Hostname to serve DevTools on (defaults to localhost).
    --port=<port>                     Port to serve DevTools on; specify 0 to automatically use any available port.
                                      (defaults to "9100")
    --[no-]launch-browser             Launches DevTools in a browser immediately at start.
                                      (defaults to on unless in --machine mode)
    --machine                         Sets output format to JSON for consumption in tools.

Memory profiling options:
    --record-memory-profile=<file>    Start devtools headlessly and write memory profiling samples to the indicated file.
                                      (defaults to "memory_samples.json")

App size options;
    --appSizeBase=<appSizeBase>       Path to the base app size file used for app size debugging.
    --appSizeTest=<appSizeTest>       Path to the test app size file used for app size debugging.
                                      This file should only be specified if --appSizeBase is also specified.

Advanced options:
    --try-ports=<count>               The number of ascending ports to try binding to before failing with an error. 
                                      (defaults to "10")
    --enable-notifications            Requests notification permissions immediately when a client connects back to the server.
    --allow-embedding                 Allow embedding DevTools inside an iframe.
    --headless                        Causes the server to spawn Chrome in headless mode for use in automated testing.

@devoncarew
devoncarew requested a review from kenzieschmoll June 15, 2021 22:09
// TODO: Remove this - prefer that clients use the rest arg.
parser
..addOption(
argVmUri,

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.

Do we know whether this can be removed yet? --vm-uri

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.

@jacob314 do you know if this is used anywhere?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I just verified. It is not used in vscode, flutter-intellij or flutter.


parser
..addOption(
argAppSizeBase,

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.

Longer term, we way want to deprecate --appSizeBase and --appSizeTest in favor of naming the options something like --app-size-base and --app-size-test.

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.

Would you mind filing an issue for this and linking it in a TODO here?

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.

done! #3146

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.

3 participants