bash completion for renku commands

[jachro]

As a Renku CLI user, I'd like to have some bash-completion for Renku commands so when I press the key I either get the command I started typing completed or when I pressed twice I get shown the possibilities I can choose from.

Acceptance criteria:

• when there's a single possibility to finish the command I've typed in and I pressed the key, the command should be completed.
  Example:

%> renku datas + <TAB>
%> renku dataset 

• when there are multiple possibilities to what I've typed in and I pressed twice, I should see the available options.
  Example:

%> renku dataset + <TAB> + <TAB>
add create
%> renku dataset 

• the completion should work for project specific keywords/values like dataset names.

[rokroskar]

This was done in SwissDataScienceCenter/renku-python#351

After running

renku --install-completion

you get

$ renku <tab> <tab>
clone     dataset   githooks  init      migrate   rerun     run       status    update
config    doctor    help      log       mv        rm        show      storage   workflow
$ renku dataset <tab> <tab>
add       create    edit      export    import    ls-files  ls-tags   rm        rm-tags   tag       unlink    update

However, afaik it does not autocomplete e.g. dataset names. And, as always, this feature could benefit from better documentation!

[jachro]

Oh cool! Could we add it to the templates by default maybe?

[rokroskar]

That's a good idea! I haven't tried using the auto-complete in a long time so I'm a bit worried unleashing it on the users unvetted, but maybe "it just works"?

[jachro]

It looks it works although it's somehow slow. And it would be nice if it's able to complete the project-specific keywords/values as I mentioned.

[rokroskar]

I agree - the slowness comes from the general slowness of the CLI... it also depends how you install it, if it's installed from pip directly it's a bit faster.

[rokroskar]

I am moving this issue to the renkulab-docker repo - we should add the auto-completion to the entrypoint and/or Dockerfile.