Skip to content

UX: Shortened commands/aliases for various commands #591

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

Merged
merged 1 commit into from
Jan 4, 2018

Conversation

screamerbg
Copy link
Contributor

@screamerbg screamerbg commented Dec 22, 2017

This adds short aliases for various commands, similar to hg/mercurial style.

For example:

  • mbed up = mbed update
  • mbed pub = mbed publish
  • mbed st = mbed status
  • mbed rel = mbed releases
  • mbed im = mbed import
  • mbed cfg = mbed config
  • mbed det = mbed detect

Backwards compatibility
This patch is fully backwards compatible

Documentation
We'd like to keep the documentation consistent with the full mbed CLI commands. A developer might use the short commands, but for clarity all public docs should use the full commands.

Also similarly to hg/mercurial, aliases are not shown in mbed --help (see hg --help).

…yle.

For example
`mbed up` = `mbed update`
`mbed pub` = `mbed publish`
`mbed st` = `mbed status`
`mbed rel` = `mbed releases`
`mbed im` = `mbed import`
@screamerbg screamerbg changed the title UX: Short command aliases for various commands UX: Shortened commands/aliases for various commands Dec 22, 2017
Copy link
Contributor

@sg- sg- left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@screamerbg screamerbg merged commit dd543b7 into ARMmbed:master Jan 4, 2018
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.

4 participants