coiled / feedback

A place to provide Coiled feedback
14 stars 3 forks source link

Enhancement request: improve docs & help for CLI `coiled install` #131

Closed jgawad-nlmk closed 3 years ago

jgawad-nlmk commented 3 years ago

Hi guys,

You might consider improving documentation of coiled install, which is pretty much unclear at the moment.

The required argument to coiled install is COILED_URI, but:

Proposed improvement:

Most of this information is already available in docs of coiled.install(coiled_uri), so it should not be much trouble to output it in coiled install --help.

FabioRosado commented 3 years ago

Thank you again for your comments and feedback, I agree that we need to improve our documentation regarding the CLI options and we should rename this argument to something different.

Just to clarify COILED_URI is meant to be the software environment identifier (<account>/<software env name> or just <software env name> if the environment is in the same account.)

FabioRosado commented 3 years ago

Hello, this is now live on our latest coiled version (0.0.39.1), thank you so much for the feedback