Shell completion

[timfallmk]

A simple WIP PR to enable basic shell completion using urfave/cli's built in shell completion function.

The method has two parts:

• An "autocomplete" script that, when sourced (source is here), adds the completion to the shell
• A --generate-<shell>-completion function that outputs the inline subcommands for the above script.

I've enabled the second part (it's just one line), but the first would need to be distributed in some way along with the CLI. Since I don't know your install methods, any insight here would be appreciated.

For an example of how this can be done in practice, see here

If approved, zsh completion can easily be added along with bash.

References:

• keybase client should support bash completion keybase-issues#147
• keybase client should support zsh completion keybase-issues#519

[timfallmk]

bump?

[patrickxb]

@timfallmk thanks for this PR.

Shell completion would be nice. Do you know if there's a way to support subcommands?

I see that (if installed) this would complete keybase t + TAB to keybase team but it doesn't look like it will do keybase team add + TAB to keybase team add-member.

[timfallmk]

@patrickxb That's a good point.

The default completion command is pretty limited. It should be pretty trivial to write a completion function that descends through any subcommand trees as well. If that's of interest I'd be happy to look into it.

[timfallmk]

@patrickxb Actually I might be wrong. It's possible that this works as intended already. I'll double check and report back.

Edit: Confirmed subcommands are also added!

[timfallmk]

🆙

[patrickxb]

That's cool.

When I tried it, it only generated completions for the root commands. Can you show me the generated file with the subcommands?

[timfallmk]

@patrickxb Source pulled directly from here. Added to ~/.bash_profile via

PROG=keybase source /path/to/bash_autocomplete

[timfallmk]

If this isn't of any interest, I'll close out the PR.

[espoelstra]

A slightly easier way to get the completion per the CLI library's directions now that the --generate-bash-completion has been merged is below.

wget https://github.com/urfave/cli/raw/master/autocomplete/bash_autocomplete -O keybase.completion
sudo mv keybase.completion /etc/bash_completion.d/keybase
# '. ~/some-file' and 'source ~/some-file' are equivalent, but 'source' only exists in Bash
. /etc/bash_completion.d/keybase
# or source your .bashrc
# . ~/.bashrc

The reason I prefer to use the /etc/bash_completion.d/ directory rather than /usr/share/bash-completion/ is that /etc is for user configurations, while /usr/share is typically for files provided by packages. Just try ls /etc/bash_completion.d/ and ls /usr/share/bash-completion to see the evidence of this.

[jasonkarns]

Note for homebrew users of bash-completion2: drop the keybase script in /usr/local/etc/bash_completion.d and it'll automatically be sourced without modification to your bashrc.