To learn more about the best way to enable completions in each shell, I read the Cobra docs: https://cobra.dev/docs/how-to-guides/shell-completion/
It has general guidance, plus shell-specific details.
If I was writing my own CLI tool, and I wanted to provide documentation for my end-users to enable completions in their shell, I might copy-paste Cobra's page and rename ./your-cli to my tool's name. What if tab could generate those docs for me?
This can even be a page on tab's documentation website which CLI authors can link to. It can read URL query parameters to customize the documentation, for example: https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
This page will render documentation, identical to cobra's page, customized for myfancycli. In the README for myfancycli, I can link to this page:
To enable completions, run myfancycli completion . For more detailed instructions see https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
To learn more about the best way to enable completions in each shell, I read the Cobra docs: https://cobra.dev/docs/how-to-guides/shell-completion/
It has general guidance, plus shell-specific details.
If I was writing my own CLI tool, and I wanted to provide documentation for my end-users to enable completions in their shell, I might copy-paste Cobra's page and rename
./your-clito my tool's name. What if tab could generate those docs for me?This can even be a page on tab's documentation website which CLI authors can link to. It can read URL query parameters to customize the documentation, for example: https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
This page will render documentation, identical to cobra's page, customized for
myfancycli. In the README formyfancycli, I can link to this page: