firefly-cli icon indicating copy to clipboard operation
firefly-cli copied to clipboard

Enhance CLI arguments

Open EnriqueL8 opened this issue 1 year ago • 4 comments

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:

  • --remote-node-url and -n should not work together as one is pointing to a remote node and the other specifying what flavour (besu for example) to run a node locally in Docker.
  • --contract-address and --remote-node-deploy some confusing caused on how to deploy the multiparty contract

@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!

EnriqueL8 avatar Feb 26 '24 11:02 EnriqueL8

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:

  • Other flags / parameters that are considered contradictory;
  • How the error message should look? Ideally, an example with a similar error message will be beneficial as well.

Thanks in advance for your consideration.

betasve avatar Oct 28 '24 09:10 betasve

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.

matthew1001 avatar Oct 28 '24 10:10 matthew1001

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 avatar Oct 28 '24 11:10 betasve

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

betasve avatar Nov 04 '24 07:11 betasve