evently-cloud / cli

Evently Command-Line Interface
Apache License 2.0
1 stars 0 forks source link

`evently registry:list-events --help` shows all the flags for all the commands #37

Closed mattbishop closed 1 year ago

mattbishop commented 1 year ago

Not sure if there's away to scope help to just registry:list-events?

evert commented 1 year ago

I'm getting this result:

./bin/run registry:list-events --help
USAGE
  $ evently registry:list-events -n <value> [-t <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -n, --entity=<value>  (required) Entity name
  -t, --token=<value>   [default: NOT-SET] Access token for your ledger.
  -x, --extended        show extra columns
  --columns=<value>     only show provided columns (comma-separated)
  --csv                 output is csv format [alias: --output=csv]
  --filter=<value>      filter property by partial string matching, ex: name=foo
  --no-header           hide table header from output
  --no-truncate         do not truncate output to fit screen
  --output=<option>     output in a more machine friendly format
                        <options: csv|json|yaml>
  --sort=<value>        property to sort by (prepend '-' for descending)

EXAMPLES
  $ evently registry:list-events --entity my-entity

Believe it or not, those are all valid options for that command because we're using the 'table' feature of oclif, which lets you reformat, sort, filter and convert to csv.

evert commented 1 year ago

Also a remidner to look at this @mattbishop . Working on selectors now which will have a similar set of arguments given that it also uses a table.

mattbishop commented 1 year ago

Ok, it's a feature. Probably useful, nice to have OOTB capabilities.