search

elves / elvish

Powerful scripting language & versatile interactive shell
https://elv.sh/
BSD 2-Clause "Simplified" License
5.53k stars 297 forks source link

document interactive key bindings #1719

Open eMBee opened 10 months ago

eMBee commented 10 months ago

i was very confused that some well known key bindings from other shells are not working.

that led me to a search to find that the default keybindings are not documented yet:

https://elv.sh/learn/fundamentals.html#editing-the-command-line

just says TODO.

i am creating this issue to track that so that it eventually may get fixed.

in addition to filling out that TODO i would also propose that the quick tour starts with a brief section about interactive editing that links to the above editing section in fundamentals, but also explains how to activate readline-bindings or vim command mode for those who want them.

dxlr8r commented 9 months ago

As an interactive shell, keybindings is very important to any user looking to use elvish as an interactive shell.

krader1961 commented 5 months ago

Note that documenting the key bindings is complicated because many depend on the current "mode"; e.g., are we in "insert", "location", "history", or some other mode. Which is not to imply the default bindings shouldn't be documented. At a minimum the documentation should explain how to use introspection to determine the current bindings. For example, pprint $edit:insert:binding.

i was very confused that some well known key bindings from other shells are not working.

I know it has been several months since you opened this issue, @eMBee, but do you recall which key bindings did not work as you expected? It is possible that adding use readline-binding to your ~/.config/elvish/rc.elv would provide the bindings you expected.