how to get the shell auto-complete files

[topazus]

Is there a way to get the shell auto-complete files from github repository?

[ClementTsang]

They are automatically included in the stable and nightly releases (e.g. https://github.com/ClementTsang/bottom/releases/download/0.6.8/completion.tar.gz)

[topazus]

Thanks for the reply. It would be much better if you could include these shell completion files in github repo.

[ClementTsang]

I probably won't do that as these files are auto-generated on build, sorry.

[topazus]

I probably won't do that as these files are auto-generated on build, sorry.

if i want to get in building bottom from this git source repo, how can I generate these completion files by which command?

[ClementTsang]

They're generated by the build.rs file when the BTM_GENERATE env var is set to anything. So off the top of my head, you would want to do something like:

BTM_GENERATE=true cargo build

which generates manpage + completion files.

You can see how this is done in CI here.

There's a tiny bit of a hack needed in that if you generate once, then want to generate again, you may need to set the env var to something different to force the build.rs script to retrigger (or update either the clap.rs or build.rs files) - this isn't super great but it works for the use cases I imagined most people would need to generate completions for.

---

This actually reminds me that I should really add/update some documentation on this, I guess I forgot since this functionality was only ever intended for use in CI. Will do that soon.

[ClementTsang]

Updated documentation on how to build manpages/completion found here.