Skip to content
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

CLI list/show subcommands should be consistent between types #206

Closed
jeremyh opened this issue Mar 16, 2017 · 1 comment
Closed

CLI list/show subcommands should be consistent between types #206

jeremyh opened this issue Mar 16, 2017 · 1 comment
Labels
easy A good place to start for newcomers to Data Cube improvement proposal usability

Comments

@jeremyh
Copy link
Contributor

jeremyh commented Mar 16, 2017

The outputs of the list/show subcommands are quite different in format and arguments, and some of their outputs are not currently very useful. We should make them more consistent for a better user experience.

datacube dataset [list|show]
datacube product [list|show]
datacube metadata_type [list|show]
datacube user [list|show]
@jeremyh
Copy link
Contributor Author

jeremyh commented Mar 16, 2017

To clarify, I think there's two big reasons to have the cli tools in addition to the python api, which we should emphasize in the design:

  1. Convenience: not needing to fire up a python environment when working in a shell. Most housekeeping/setup tasks are done from shell rather than python in our current docs & usage.
  2. Ability to easily use these tools together with the rest of the cli/bash/excel/etc software ecosystem. Many of the current output formats are currently not very convenient for piping to other tools. Ability to parse/extract values from the output is a plus. The dataset commands have a --format specifier for getting the output in parse-able formats like csv, which traditionally Ops used quite heavily.

@omad omad added the usability label Jul 14, 2017
@omad omad added the easy A good place to start for newcomers to Data Cube label Feb 26, 2018
@walsh-andrew walsh-andrew mentioned this issue Mar 15, 2018
3 tasks
@omad omad closed this as completed in #390 Mar 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy A good place to start for newcomers to Data Cube improvement proposal usability
Projects
None yet
Development

No branches or pull requests

2 participants