1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-30 16:21:59 +00:00
ohmyzsh/plugins/vi-mode/README.md
Marc Cornellà 2118d35e01 fix(vi-mode)!: add back edit-command-line key binding as 'vv' (#9573)
BREAKING CHANGE: the key binding to open an editor to edit the command line has
been moved from being `v` (press v once) to being `vv` (press v twice). Now, the
action for `v` is the default `visual-mode`, as is in Vim.

Fixes #9573
2021-01-04 21:41:11 +01:00

3.6 KiB

vi-mode plugin

This plugin increase vi-like zsh functionality.

To use it, add vi-mode to the plugins array in your zshrc file:

plugins=(... vi-mode)

Settings

  • VI_MODE_RESET_PROMPT_ON_MODE_CHANGE: controls whether the prompt is redrawn when switching to a different input mode. If this is unset, the mode indicator will not be updated when changing to a different mode. Set it to true to enable it. For example:

    VI_MODE_RESET_PROMPT_ON_MODE_CHANGE=true
    

    The default value is unset, unless vi_mode_prompt_info is used, in which case it'll automatically be set to true.

  • VI_MODE_SET_CURSOR: controls whether the cursor style is changed when switching to a different input mode. Set it to true to enable it (default: unset):

    VI_MODE_SET_CURSOR=true
    
  • MODE_INDICATOR: controls the string displayed when the shell is in normal mode. See Mode indicator for details.

Mode indicator

Normal mode is indicated with a red <<< mark at the right prompt, when it hasn't been defined by theme.

You can change this indicator by setting the MODE_INDICATOR variable. This setting supports Prompt Expansion sequences. For example:

MODE_INDICATOR="%F{yellow}+%f"

You can also use the vi_mode_prompt_info function in your prompt, which will display this mode indicator.

Key bindings

Use ESC or CTRL-[ to enter Normal mode.

NOTE: some of these key bindings are set by zsh by default when using a vi-mode keymap.

History

  • ctrl-p : Previous command in history
  • ctrl-n : Next command in history
  • / : Search backward in history
  • n : Repeat the last /

Vim edition

  • vv : Edit current command line in Vim

NOTE: this used to be bound to v. That is now the default (visual-mode)

Movement

  • $ : To the end of the line
  • ^ : To the first non-blank character of the line
  • 0 : To the first character of the line
  • w : [count] words forward
  • W : [count] WORDS forward
  • e : Forward to the end of word [count] inclusive
  • E : Forward to the end of WORD [count] inclusive
  • b : [count] words backward
  • B : [count] WORDS backward
  • t{char} : Till before [count]'th occurrence of {char} to the right
  • T{char} : Till before [count]'th occurrence of {char} to the left
  • f{char} : To [count]'th occurrence of {char} to the right
  • F{char} : To [count]'th occurrence of {char} to the left
  • ; : Repeat latest f, t, F or T [count] times
  • , : Repeat latest f, t, F or T in opposite direction

Insertion

  • i : Insert text before the cursor
  • I : Insert text before the first character in the line
  • a : Append text after the cursor
  • A : Append text at the end of the line
  • o : Insert new command line below the current one
  • O : Insert new command line above the current one

Delete and Insert

  • ctrl-h : While in Insert mode: delete character before the cursor
  • ctrl-w : While in Insert mode: delete word before the cursor
  • d{motion} : Delete text that {motion} moves over
  • dd : Delete line
  • D : Delete characters under the cursor until the end of the line
  • c{motion} : Delete {motion} text and start insert
  • cc : Delete line and start insert
  • C : Delete to the end of the line and start insert
  • r{char} : Replace the character under the cursor with {char}
  • R : Enter replace mode: Each character replaces existing one
  • x : Delete count characters under and after the cursor
  • X : Delete count characters before the cursor