feat: add autocompletion for kubetail cli commands

[victorchrollo14]

Overview

we would like to add autocomplete / autosuggestion when running kubetail cli commands like kubetail logs. As the user types kubetail logs pods/ then enters tab we either autocomplete the resource name or list out the pods that are currently running within the k8s cluster. This enhances the user experience significantly as most of the cli tools usually have this feature and most users expect cli tools to have autocomplete by default. let's start with the autocompletion of the resource names first then slowly expand it to all the commands and flags.

Motivation

The main motivation is to enhance user experience with using kubetail cli tool. As it is really inconvinient to run kubectl get resource-name then copy the name of the resource and paste it after kubetail logs to view the logs.

Goals

• Add autocomplete / autosuggestion to resource names in k8s.
• expand this feature to rest of the commands and flags in kubetail cli.

Non-Goals

No response

Design Overview

Explain the proposed changes in detail:

• APIs
• Data models
• Code structure
• Dependencies

Alternatives Considered

No response

Risks and Mitigations

No response

Open Questions

• How to add autocomplete / autosuggest the resource names running in k8s cluster.
• what are the best practices and tools to add this feature.

Future Work

No response

[amorey]

@rxinui Victor was using kubetail logs and reached for kubectl-like autocomplete but it wasn't there so he created this draft spec. Thoughts on how to implement it? Would you want to do this or would you prefer to help Victor do it?

[rxinui]

spf13/cobra which is the library we are using to design our CLI offers a framework to make it happen. Be aware that autocompletion is shell-dependant therefore, work has to be done for multiple shells.
See details https://github.com/spf13/cobra/blob/main/site/content/completions/_index.md

Because we cannot target every shells, here are the top 2 priorities

• zsh which is now Apple default shell
• bash which is still widely spread

We do not want it for sh even though it is available almost everywhere. This is, for a lot of people, legacy.

Potentially, ksh or fish could be the follow up.