hyperledger / firefly-cli

FireFly Command Line Interface (CLI)
Apache License 2.0
59 stars 55 forks source link

Enhance CLI arguments #290

Open EnriqueL8 opened 9 months ago

EnriqueL8 commented 9 months ago

At the last community call @matthew1001 raise the fact that the CLI arguments have become confusing and contradictory. Presence of contradictory flags does not throw an error and the behaviour is confusing to users:

@nguyer made a great comment to highlight that this CLI was built to be able to quickly run Firefly locally for development and not intended for production. There are set of helm charts for that https://github.com/hyperledger/firefly-helm-charts

@matthew1001 feel free to add more information!

betasve commented 3 weeks ago

Hello @EnriqueL8 and @matthew1001. I'm considering taking this ticket as my first task. Do you think it's ok for a newcomer to do?

Also, if it's ok to do it, maybe let's also consider:

Thanks in advance for your consideration.

matthew1001 commented 3 weeks ago

Hi @betasve, yes this would be a great way to start getting involved in contributing to FireFly. I'd be very happy for you to address other CLI parameters that you think could be improved.

I would suggest trying some invalid combinations that do throw errors, and using those as guidance for the format of any new error messages you want to add.

betasve commented 3 weeks ago

Hi @matthew1001,

Sure, thanks for your consideration. About the other parameters, I don't have any ideas currently. I was thinking if you maybe have noticed something since then that falls into that list.

Regardless, I'll move on with fixing these ones, and we can add any additional ones later on.

Thanks for your quick response.

betasve commented 2 weeks ago

Can someone, please, check my PR on this issue here? Thanks in advance.