bedrock-cli icon indicating copy to clipboard operation
bedrock-cli copied to clipboard
verified publisher icon microsoft

Re-evaluate short flags and multi-word option names on CLI

Open sarath-p opened this issue 6 years ago • 4 comments

Look at short flags in https://microsoft.github.io/bedrock-cli/commands and

  • [ ] See if we have consistency amongst commands
  • [ ] If not, propose an updated short flag name references
  • [ ] Codify these short flag names in documentation

For example, some commands have a short flag -p for --project and others have no short flag.

An effort was started in the past but is out of date here.. Use https://microsoft.github.io/bedrock-cli/commands as the source of truth

A command option should have same the same short flag and multi-word name across all CLI commands to be consistent.

Does this require updates to documentation?: YES!

sarath-p avatar Oct 31 '19 16:10 sarath-p

@mtarng @sarath-p do we have further thoughts on this? Thanks for coming up with the inventory of the current commands. Did we have a proposal on how we want SPK command to look?

andrebriggs avatar Jan 09 '20 19:01 andrebriggs

@andrebriggs - I don't think so but we can come up with a design proposal in the next sprint.

sarath-p avatar Jan 09 '20 19:01 sarath-p

@sarath-p sounds good. Looking forward to it

andrebriggs avatar Jan 15 '20 19:01 andrebriggs

An effort was started here. Let's iterate on this effort

cc @mtarng @sarath-p

andrebriggs avatar Mar 25 '20 09:03 andrebriggs