# \[zsh\] Completion plugin
**URL:** https://forum.yunohost.org/t/zsh-completion-plugin/7016
**Category:** Contribute Room
**Tags:** french, english
**Created:** [February 3, 2019, 7:11pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016 "2019-02-03T19:11:36Z")
**Posts on this page:** 9
**Page:** 1
### Author:  [@Fol](https://forum.yunohost.org/u/Fol)
#### Post date: [February 3, 2019, 7:11pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/1 "2019-02-03T19:11:36Z")
Version FR en bas
* * *
Hi there,
I am currently creating a ZSH completion plugin for the cli interface of Yunohost. Before continuing, I would like to know if someone has already tried that before, as it is beginning to be very tedious đ
(Tedious, or maybe Iâm just doing it wrong đ )
Anyway, here is the current status of my work [[1]](https://framabin.org/p/?f9dbde4ac576b8ab#ZH/TkcUW5WMRWpAGd6BocTy/4fT3lH++fQGHcXwkNn4=). I am open to any remark to on it. It is in a working state, there is looots of stuff to improve, and much more to be done. Currently, only the `yunohost user` and `yunohost domain` parts are kind of dealt with. The `yunohost app` is written, but untested, sorry đ
So, if you have any remarks or advices about my work, I would be happy to hear them đ
* * *
Salut !
Je suis en train dâĂ©crire un plugin dâautocompletion pour ZSH et Yunohost. Avant de continuer, je me demandais juste si quelquâun sây Ă©tait dĂ©jĂ attaquĂ©, vu que ça commence Ă ĂȘtre un peu rĂ©pĂ©titif et laborieux (ou alors, câest juste moi qui mây prends mal⊠đ)
En tout cas, je pose ici [[1]](https://framabin.org/p/?f9dbde4ac576b8ab#ZH/TkcUW5WMRWpAGd6BocTy/4fT3lH++fQGHcXwkNn4=) lĂ oĂč jâen suis. Câest vraiment une version de travail, toute bugguĂ©e et pas finie, soyez gentils đ
Je considĂšre que les fonctions `yunohost user` et `yunohost domain` sont Ă peu prĂšs bonnes, Ă quelques dĂ©tails prĂšs, et pour `yunohost app`, câest juste Ă©crit, mais pas testĂ© (oui, je sais, les gens bien ne publient pas sans avoir testé⊠âč). Le reste nâexiste pas.
Du coup, je me pointe ici pour avoir un retour sur ce que je suis en train de faire, si ça intĂ©resse des gens. Je suis preneur des conseils ou remarques que vous pourriez avoir đ
* * *
[1] [https://framabin.org/p/?f9dbde4ac576b8ab#ZH/TkcUW5WMRWpAGd6BocTy/4fT3lH++fQGHcXwkNn4=](https://framabin.org/p/?f9dbde4ac576b8ab#ZH/TkcUW5WMRWpAGd6BocTy/4fT3lH++fQGHcXwkNn4=)
Will be available only for one week, Iâll repost it if needed, no worries
Dispo juste pendant une semaine, je le reposeterai si besoin, pas dâinquiĂ©tude
* * *
_05-01-2019 : updated link, doesnât crash automatically anymore_
---
### Author:  [@Aleks](https://forum.yunohost.org/u/Aleks)
#### Post date: [February 4, 2019, 9:07pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/2 "2019-02-04T21:07:46Z")
I know nothing about zsh but that looks fancy.
Isnât there any way that this could be generated somewhat automatically from the action map ? [https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/actionsmap/yunohost.yml](https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/actionsmap/yunohost.yml)
---
### Author:  [@rds13](https://forum.yunohost.org/u/rds13)
#### Post date: [February 4, 2019, 9:08pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/3 "2019-02-04T21:08:15Z")
Bonjour, câest cool de proposer ça. Je suis un grand utilisateur de ZSH mais je ne suis pas un habituĂ© de ce type de dĂ©veloppement. Je ne serai donc pas te dire si tu tây prends correctement ou pas mais jâimagine que tu tâes inspirĂ© dâautres rĂ©alisations ?
---
### Author:  [@Fol](https://forum.yunohost.org/u/Fol)
#### Post date: [February 5, 2019, 12:29am UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/4 "2019-02-05T00:29:28Z")
@Aleks
Thanks for the suggestion ! đ I didnât knew about that map. A somewhat functionnal completion plugin could be generated from it, but it would lack some information I think.
Typically, I would like to provide system dependent lists for commands like `yunohost app info `, the content of `` being fetch from `yunohost app list -i`. I donât see how this can be achived directly from the map, without having to add extra information after the generation of the zshâs plugin. đ
* * *
@rds13 : Je nâai pas du tout lâhabitude de faire ce genre de trucs. Je viens de passer Ă zsh il y a quelques semaines, et, horreur, yâa pas de complĂ©tion pour YunoHost ! đ± Du coup, je me lance, Ă lâarrache, en regardant comment câest fait ailleurs đ
Jâai pas mal galĂ©rĂ© Ă trouver une façon de faire pas trop moche pour les commandes Ă tiroir de Yunohost (les `yunohost --option `, mais ça a lâair de fonctionner de ce que je vois.
Je mettrai Ă jour le lien du post dâouverture quand jâaurai un truc qui couvrira une majeure partie de lâapplication.
---
### Author:  [@Aleks](https://forum.yunohost.org/u/Aleks)
#### Post date: [February 5, 2019, 12:41am UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/5 "2019-02-05T00:41:59Z")
> [@Fol](#):
>
> Typically, I would like to provide system dependent lists for commands like `yunohost app info ` , the content of `` being fetch from `yunohost app list -i` . I donât see how this can be achived directly from the map, without having to add extra information after the generation of the zshâs plugin.
Ah yeah I see⊠What you want to achieve is one order of magnitude higher than what I was thinking about đ Yet I really think you should aim to automatize things, so that the autocompletion plugin can evolve automatically as yunohost evolve ⊠(if youâre aiming for a long-term thing)
So about this problem with autocompletion of arguments, donât you think we imagine to add keys or annotation or idk to the roadmap so that this kind of info could be contained in it ?
For instance :
```auto
### app_info()
info:
action_help: Get information about an installed app
api: GET /apps/
arguments:
app:
help: Specific app ID
autocomplete:
from: app list --installed
key: id
```
I donât know / havenât though about all the use case though so I donât know if we can really imagine something that would cover all of them
---
### Author:  [@Fol](https://forum.yunohost.org/u/Fol)
#### Post date: [February 5, 2019, 2:56pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/6 "2019-02-05T14:56:36Z")
> [@Aleks](#):
>
> I donât know / havenât though about all the use case though so I donât know if we can really imagine something that would cover all of them
As I havenât yet been through all possible cases, I canât precisely answer to that. It should be possible to have an autocomplete property where itâs needed, maybe in a more generic form, as completion from a file instead of a command may be needed.
For instance:
```auto
### app_setting()
setting:
action_help: Set or get an app setting value
api: GET /apps//settings
arguments:
app:
help: App ID
autocomplete:
from: app list --installed
key: id
key:
help: Key to get/set
autocomplete:
from: /etc/yunohost//settings.yml
key: keys
```
Anyway. You are right about generating this file automatically from the actionmap file. I will come back here if I manage to write something not too ugly đ
---
### Author:  [@Aleks](https://forum.yunohost.org/u/Aleks)
#### Post date: [February 5, 2019, 3:00pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/7 "2019-02-05T15:00:48Z")
Alright ! I know that itâs probably a bit more meta and technical but I think itâs worth it đ Iâm not particularly a zsh fanboy or anything (I think i prefer the bash vanilla experience) but if that significantly improves the UX for people using the CLI (and not willing to run ten commands with --help to know how to build the command) that would be really great to integrate this in yunohost on the long-term.
Also donât hesitate to come discuss and ask questions if you need, on the dev chatroom : [https://yunohost.org/#/chat\_rooms](https://yunohost.org/#/chat_rooms)
---
### Author:  [@Fol](https://forum.yunohost.org/u/Fol)
#### Post date: [April 25, 2020, 6:33pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/8 "2020-04-25T18:33:05Z")
Hello,
I am in a mood of ressurecting this idea đ
The way I am more inclined to do it is like suggested by Aleks, adding an property `autocomplete: {from: .... ; key: ... }`, where `key` would typically be a `jq` filter, as this tool seems to be installed by default (correct me if Iâm wrong).
However, the properties `pattern` and `metavar` are puzzling me. I initially thought (a few day ago when unearthing this project đ
) that one of them could be of help.
I did not got how those are used in the code however, and thus I donât know if/how they could be used đ§
---
### Author:  [@Fol](https://forum.yunohost.org/u/Fol)
#### Post date: [July 31, 2020, 2:44pm UTC](https://forum.yunohost.org/t/zsh-completion-plugin/7016/9 "2020-07-31T14:44:15Z")
Sooo⊠I have finally something worth showing, and kinda usable!
This conversation should continue on Github I guess, as a PR in the main repo?
Anyway, if someone wants to check that zsh completion plugin, it is here. It work, but there is lots of room for improvement (naming, coding style, architectural choices, âŠ)
> **[buzuck/yunohost](https://github.com/buzuck/yunohost/tree/enh-zsh-completion)**
>
> YunoHost is an operating system aiming to simplify as much as possible the administration of a server. This repository corresponds to the core code, written mostly in Python and Bash. - buzuck/yuno...
* * *
Edit: Actually, the PR will wait a bit, I have to recheck my code first, and add lots of comments ^^â
* * *
2nd edit: PR done! Itâs my first, so I hope I didnât make it too badly ^^â