New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor command line interface (especially "platform" related commands) #158

Closed
ivankravets opened this Issue Apr 6, 2015 · 2 comments

Comments

Projects
None yet
2 participants
@ivankravets
Member

ivankravets commented Apr 6, 2015

PlatformIO 1.0 CLI

$ platformio --help
Usage: platformio [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  boards       Pre-configured Embedded Boards
  init         Initialize new PlatformIO based project
  install      Install new platforms
  lib          Library Manager
  list         List installed platforms
  run          Process project environments
  search       Search for development platforms
  serialports  List or Monitor Serial ports
  settings     Manage PlatformIO settings
  show         Show details about installed platform
  uninstall    Uninstall platforms
  update       Update installed platforms
  upgrade      Upgrade PlatformIO to the latest version

PlatformIO 2.0 CLI

  1. Add global -f/--force option which will force to accept any confirmation prompts // issue #152
  2. Move platform related commands to platformio platforms commands group
  3. Update: development platforms, packages and libs by general platformio update command.
$ platformio --help
Usage: platformio [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.
  --force    Accept any confirmation prompts

Commands:
  boards       Pre-configured Embedded Boards
  init         Initialize new PlatformIO based project
  lib          Library Manager
  platforms    Manage development platforms
  run          Process project environments
  serialports  List or Monitor Serial ports
  settings     Manage PlatformIO settings
  update       Update installed platforms and libs
  upgrade      Upgrade PlatformIO to the latest version


$ platformio platforms --help
Usage: platformio platforms [OPTIONS] COMMAND [ARGS]...

Options:
  --help     Show this message and exit.

Commands:
  install      Install new platforms
  list         List installed platforms
  search       Search for development platforms
  show         Show details about installed platform
  uninstall    Uninstall platforms
  update       Update installed platforms

Friends @valeros, @gandy92, @pelikhan, @aphelps, @ncolomer,

  • What do you think?
  • Do you like these "s" endings in the most commands? Should I replace them with board, platform, serialport?

@ivankravets ivankravets self-assigned this Apr 6, 2015

@ivankravets ivankravets added this to the 2.0.0 milestone Apr 6, 2015

@aphelps

This comment has been minimized.

aphelps commented Apr 6, 2015

For the 's' ending, I really don't have a preference.

For the addition of the -q/--quiet option, is the intent here to just bypass places where user confirmation is required? Unix "conventions" tend to have -q mean "use less verbose logging", whereas -f/--force or -Y/--yes is used to bypass prompts for user confirmation.

@ivankravets ivankravets referenced this issue Apr 6, 2015

Closed

PlatformIO 2.0 #159

11 of 11 tasks complete
@ivankravets

This comment has been minimized.

Member

ivankravets commented Apr 6, 2015

@aphelps thanks! I've just changed #152 to -f, --force 👍

ivankravets added a commit that referenced this issue Apr 24, 2015

ivankravets added a commit that referenced this issue Apr 30, 2015

ivankravets added a commit that referenced this issue May 22, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment