saf icon indicating copy to clipboard operation
saf copied to clipboard

Use Oclif's DocOps Functunality for Usage Strings

Open em-c-rod opened this issue 2 years ago • 0 comments

These are the standards for writing the CLI inputs: http://docopt.org/ OCLIF has made it so there can be automated usage strings if we update the flags. Here is OCLIF's PR on that: https://github.com/oclif/core/pull/188/files

Update the flags to utilize this new oclif functionality by:

  • making sure the package.json has a version of oclif with updated usage string generation from docops
  • update all command flags long names to use dashes instead of camel case (ex: change logLevel to log-level and so on)
  • update flags to show "exlusive", etc, key words and autogenerate usage strings
  • update README with changes

Also reference #710

em-c-rod avatar Dec 30 '22 18:12 em-c-rod