Support generating shell completions

[orhun]

closes #232

[conradludgate]

Quick question, who's expected to run these shell completions and where should they be saved to? Obviously through pacman will set them up automatically I presume but what about installing directly through cargo?

[orhun]

Quick question, who's expected to run these shell completions and where should they be saved to? Obviously through pacman will set them up automatically I presume but what about installing directly through cargo?

This is mainly for distro packages, for example, you can install shell completions for Atuin on Arch Linux like this:

install -Dm 644 "completions/atuin.bash" "/usr/share/bash-completion/completions/atuin"
install -Dm 644 "completions/atuin.fish" -t "/usr/share/fish/vendor_completions.d"
install -Dm 644 "completions/_atuin" -t "/usr/share/zsh/site-functions"

More info: https://wiki.archlinux.org/title/Shell_package_guidelines#Shell_completions

Since they have to be placed into an appropriate location based on the current platform, I don't think they can be installed directly through cargo install.

[conradludgate]

I'm happy with this. Considering whether we should move to running in a build script but overall I have no real preference either way.

Thanks for your contributions, I'll wait for @ellie to take a look

[ellie]

Fantastic, thank you! I'm happy with this. I agree with @orhun, it's up to the distro/end user to handle sorting the installation of the completion files, I think it's out of scope for something we should be thinking about

[SuperSandro2000]

How can I output the completion to stdout?

[conradludgate]

How can I output the completion to stdout?

You could generate them into a local or a temp dir, then cat the contents