bedrock icon indicating copy to clipboard operation
bedrock copied to clipboard

Bedrock CLI should have consistent command line style

Open andrebriggs opened this issue 5 years ago • 2 comments

SPK command line arg aliases have mismatches have inconsistency issues.

We should have a style guide to make sure things are consistent. If possible we can probably automate this since the command line args are in json files.

  • [x] Create a guidelines doc https://github.com/CatalystCode/spk/pull/342
  • [x] Create a tool to print out usage of option aliases for all commands so that we have a good view of how and where these aliases are used

arg aliases

-V -v -h are reserved for --version, --verbose and --help

-f for --file -a for --personal-access-token -o for --org-name -O for --output -d for --devops-project -U for url related option -M for --manifest-url because -U is already used in the same command -B for --build-script-url

  • [ ] Make short flags and multi-word option names and descriptions consistent across all spk commands #741

andrebriggs avatar Feb 25 '20 19:02 andrebriggs

arg aliases

-V -v -h are reserved for --version, --verbose and --help

-f for --file

in PR https://github.com/CatalystCode/spk/pull/340 -a for --personal-access-token -o for --org-name -O for --output

dennisseah avatar Feb 26 '20 04:02 dennisseah

Related: https://github.com/microsoft/bedrock/issues/741

mtarng avatar Feb 26 '20 05:02 mtarng