search

hotg-ai / rune

Rune provides containers to encapsulate and deploy edgeML pipelines and applications
Apache License 2.0
136 stars 15 forks source link

Make the `rune run` CLI more ergonomic #169

Closed Michael-F-Bryan closed 3 years ago

Michael-F-Bryan commented 3 years ago

At the moment, if you want to pass a capability to the CLI runtime for use during execution you need to use something like this --capability image:./whatever.png (i.e. all capabilities go via --capability and you add a leading image: to specify which type).

During QA @akshr had to ask which capabilities were supported, which means this isn't very discoverable. Having the leading image: also interferes with autocomplete, which is another unnecessary papercut.

The rune run command should switch to a syntax closer --image person.png because then the supported capabilities will appear whenever you run rune run --help.

Michael-F-Bryan commented 3 years ago

Some feedback on the current interface from Akshay on Slack:

a few right off the top of my head:

  • i dont have a list of enumerable capabilities i know
  • I should have a way to either point to a .rune file or Runefile and know what capabilities are supported failing to pass those args should output better message from the cli - saying you need to supply xyz etc
  • even better if someone does rune run just-rune-file it populates the whole command back for them :
  • This rune requires you to pass following capabillies audio or image. Run it as: rune run --capability: ....