Autocompletion for shells

[founderio]

Auto completion for the cli options and available pages would be nice.
Something along the lines of the zsh and bash completions here: https://github.com/tldr-pages/tldr-node-client/tree/master/bin

This client currently does not have an option to list all available pages it seems, which would be a requirement.

[jn64]

Here is a quick solution for bash autocomplete. Simply add to .bashrc or other file that is sourced in your shell:

TLDR_CACHE_DIR="${HOME}/.cache/tldr"
complete -W "$(q=(${TLDR_CACHE_DIR}/*); sed 's/_[a-zA-Z]\+\.md//g' <<<${q[@]##*/})" tldr

Based on tldr-bash-client

(I'm using tldr-python-client v0.5 as packaged on Fedora 32, have not updated to 1.0)

[zlatanvasovic]

@jn64 This probably can be implemented nicely in Python too.

[merwok]

For reference, I think this is the classic tool used for this: https://pypi.org/project/argcomplete/

[MasterOdin]

I think using argcomplete is probably the better move as it would allow us to handle autocompletion for a specific language / platform, be it specified by configuration or option flag. Adding this to 1.1 milestone.

[zlatanvasovic]

@merwok Good idea, thanks for noting.

[jrom99]

Hello, I'm not sure if this is the right place to report, but I'm currently experiencing problems with auto-completion after installing it via dnf install tldr, it is placing backslashes behind every space, which is trashing the completion into a single line of items.

tldr --update_cache
# tldr[TAB] adds one space normally
# tldr[TAB][TAB] shows every package available in a single line as if there was one completion option
tldr \ \ pacman\ query\ \ \ \ insmod\ \ \ \ st\ \ \ \ cockpit\ ws\ \ \ \ ntfsfix\ \ \ \ distrobox\ host\ exec\ \ \ \ ostree\ \ \ \ timeshift\ \ \ \ pamac\ \ \ \ uuid\ \ \ \ ip\ route\ list\ \ \ \ a2query\ \ \ \ daemon\ \ \ \ pw\ play\ \ \ \ mkinitcpio\ \ \ \ id3v2\ \ \ \ at\ \ \ \ ego\ \ \ \ sacctmgr\ \ \ \ smbclient\ \ \ \ sar\ \ \ \ toolbox\ init\ container\ \ \ \ pmount\ \ \ \ nmcli

System information:

• tldr 3.1.0 (Client Specification 1.5)
• Fedora 38 (6.2.12-300.fc38.x86_64 #1 SMP PREEMPT_DYNAMIC)
• Bash version 5.2.15(1)-release (x86_64-redhat-linux-gnu)