geostore icon indicating copy to clipboard operation
geostore copied to clipboard

Geostore CLI nice-to-haves

Open l0b0 opened this issue 3 years ago • 1 comments

This is a bit of a free-for-all for features. We'll have to clean up and split into manageable stories once we have more time.

User Story

So that the Geostore CLI is as useful as possible, as a dataset maintainer, I want to it to have standard bells and whistles.

Acceptance Criteria

  • [ ] Given [a pre-condition], when [an event happens], then [an expected outcome occurs]
  • [ ] Given [a pre-condition], when [an event happens], then [an expected outcome occurs]

Additional context

Tasks

From @billgeo testing on v0.1.6, in order of priority:
  • [ ] #1190

  • [ ] #1191

  • [ ] #1192

  • [ ] #1193

  • [ ] Show all json validation issues, not just the first one encountered. [split to new issue]

  • [ ] Add the ability to get a list of versions for a dataset? Needs to talk to the S3 bucket? Could leave until we change the versioning.

  • [ ] Improve message if $AWS_PROFILE isn't set. It says something cryptic like, 'have you logged into AWS?'. I had via aws-azure-login but I hadn't set that variable so had to figure that out myself. Could just add more info in the message return to the user and the help docs in the CLI, and/or add an option to specify a profile.

  • [ ] At geostore --help, remove install-completion and show-completion options? Or explain what they mean? See here

Add to logging/monitoring/troubleshooting improvements

  • [ ] Indicate that the call came from the CLI
@l0b0 idea's
  • [ ] #1194

  • [ ] #1196

  • [ ] #1197

  • [ ] Implement --verbose flag to print more human readable but non-programmable output? See if users can use the --json option?

  • [ ] Implement --full-help (or something equivalent, like a man page) to be able to learn the full CLI synopsis in one go.

  • [ ] Implement --color=never|auto|always flag to override default behaviour?

  • [ ] Implement --debug for raw output? Will do this later, when we need it.

Definition of Ready

Definition of Done

l0b0 avatar Nov 03 '21 21:11 l0b0

Added some ideas to this @l0b0. Let's discuss these though and come up with an order of priority.

billgeo avatar Nov 09 '21 21:11 billgeo