clikt icon indicating copy to clipboard operation
clikt copied to clipboard

Support for zsh parameter and subcommand description with autocompletion

Open jakobkmar opened this issue 2 years ago • 1 comments

Zsh has support for showing the description of parameters and subcommands.

Example: image

Can Clikt generate a completion script which shows these helpful descriptions?

jakobkmar avatar Jul 16 '21 23:07 jakobkmar

The ZSH completion is implemented using bashcompinit, which doesn't support descriptions AFAIK.

I'd welcome a PR if you want to write a new completion generator that uses the ZSH-native completion APIs. You could look at the FishCompletionGenerator for an example of a generator that includes help descriptions.

ajalt avatar Jul 19 '21 16:07 ajalt