IdeaVim ===

[![Official JetBrains Project][jb-official-svg]][jb-official] [![Contributions welcome][contributions-welcome-svg]][contributions-welcome] [![Downloads][plugin-downloads-svg]][plugin-repo] [![Rating][plugin-rating-svg]][plugin-repo] [![Version][plugin-version-svg]][plugin-repo] [![Gitter][gitter-svg]][gitter] [![Twitter][twitter-svg]][twitter]

IdeaVim is a Vim engine for JetBrains IDEs.

Contact maintainers:

• Bug tracker
• @IdeaVim on Twitter
• Chat on gitter
• IdeaVim Channel on JetBrains Server

Resources:

• Plugin homepage
• Plugin on Marketplace
• Changelog
• Continuous integration builds

Compatibility

IntelliJ IDEA, PyCharm, GoLand, CLion, PhpStorm, WebStorm, RubyMine, DataGrip, DataSpell, Rider, Cursive, Android Studio, and other JetBrains IDEs.

Setup

• IdeaVim can be installed via Settings | Plugins.

• Use Tools | Vim in the menu to enable or disable vim.

• Use the ~/.ideavimrc file as an analog of ~/.vimrc (learn more). The XDG standard is supported, as well.

• Shortcut conflicts can be resolved by using:

Get Early Access

Would you like to try new features and fixes? Join the Early Access Program and receive EAP builds as updates!

• Click the IdeaVim icon

Or subscribe to EAP updates manually:

• Open Settings | Plugins
• Click the gear icon :gear:, select Manage Plugin Repositories, and add the following url:

https://plugins.jetbrains.com/plugins/eap/ideavim

See the changelog for the list of unreleased features.

It is important to distinguish EAP builds from traditional pre-release software. Please note that the quality of EAP versions may at times be way below even usual beta standards.

You can always leave your feedback with:

• @IdeaVim in Twitter
• Bug tracker

Summary of Supported Vim Features

Here are some examples of supported vim features and commands:

• Normal / insert / visual / select / etc. modes
• Motion / deletion / change / window / etc. commands
• Key mappings
• Marks / Macros / Digraphs / Registers
• Some set commands
• Full Vim regexps for search and search/replace
• Vim web help
• ~/.ideavimrc configuration file
• Vim script, including some builtin functions
• IdeaVim plugins

• Top feature requests and bugs

• ~/.ideavimrc

""" Map leader to space ---------------------
let mapleader=" "
""" Plugins  -------------------------------- set surround set multiple-cursors set commentary set argtextobj set easymotion set textobj-entire set ReplaceWithRegister
""" Plugin settings ------------------------- let g:argtextobj_pairs="[:],(:),<:>"
""" Common settings ------------------------- set showmode set so=5 set incsearch set nu
""" Idea specific settings ------------------ set ideajoin set ideastatusicon=gray set idearefactormode=keep
""" Mappings -------------------------------- map <leader>f <Plug>(easymotion-s) map <leader>e <Plug>(easymotion-f)
map <leader>d <Action>(Debug) map <leader>r <Action>(RenameElement) map <leader>c <Action>(Stop) map <leader>z <Action>(ToggleDistractionFreeMode)
map <leader>s <Action>(SelectInProjectView) map <leader>a <Action>(Annotate) map <leader>h <Action>(Vcs.ShowTabbedFileHistory) map <S-Space> <Action>(GotoNextError)
map <leader>b <Action>(ToggleLineBreakpoint) map <leader>o <Action>(FileStructurePopup)

" Show a few lines of context around the cursor. Note that this makes the
" text scroll if you mouse-click near the start or end of the window.
set scrolloff=5
" Do incremental searching. set incsearch
" Don't use Ex mode, use Q for formatting. map Q gq

You can read your ~/.vimrc file from ~/.ideavimrc with this command:

source ~/.vimrc

Also note that if you have overridden the user.home JVM option, this will affect where IdeaVim looks for your .ideavimrc file. For example, if you have -Duser.home=/my/alternate/home then IdeaVim will source /my/alternate/home/.ideavimrc instead of ~/.ideavimrc.

Alternatively, you can set up initialization commands using XDG standard. Put your settings to $XDGCONFIGHOME/ideavim/ideavimrc file.

You can also set a custom path for your .ideavimrc file using the IDEAVIMCUSTOM_VIMRC environment variable. If set, IdeaVim will use this path instead of the default locations.

IdeaVim Plugins

See doc/IdeaVim Plugins.md

Executing IDE Actions

IdeaVim adds various commands for listing and executing arbitrary IDE actions as Ex commands or via :map command mappings:

Executing actions:

• <Action>({action_id})

• :action {action_id}

Finding action IDs:

• IJ provides IdeaVim: track action IDs command to show the id of the executed actions.

"Track action IDs" Details (click to see)

• :actionlist [pattern]

Examples:

" Map \r to the Reformat Code action
:map \r <Action>(ReformatCode)
" Map <leader>d to start debug :map <leader>d <Action>(Debug)
" Map \b to toggle the breakpoint on the current line :map \b <Action>(ToggleLineBreakpoint)

Some popular actions:

ShowHoverInfo - Quick Documentation and Error Description
QuickImplementations - Quick Definition

Autocmd

IdeaVim supports Vim’s :autocmd for running commands on editor events, including InsertEnter/InsertLeave, buffer events (BufEnter, BufLeave, BufRead, BufNewFile, BufWritePre, BufWritePost), window events (WinEnter, WinLeave), focus events (FocusGained, FocusLost), and FileType. Full glob patterns (, *, ?, [abc], {a,b}) and augroups are supported.

autocmd BufWritePre *.py echo "saving python"
autocmd FileType python setlocal shiftwidth=4

See doc/autocmd.md for the full event reference, firing order, and notes on IntelliJ-specific differences.

Vim Script

IdeaVim can execute custom scripts that are written with Vim Script. At the moment we support all language features, but not all of the built-in functions and options are supported.

Additionally, you may be interested in the Vim Script Discussion.

IDE specific options

You can evaluate the has('ide') function call and get 1 if it was called with IdeaVim or 0 if the function was called from Vim/NeoVim. The option &ide contains the name and edition of your IDE, for example, "IntelliJ IDEA Ultimate Edition". To see its value for the current IDE you are using, execute the :echo &ide command. To write an IDE-specific configuration, use Vim's regexp match operators =~? (case-insensitive) / =~# (case-sensitive)

Example config:

" options and mappings that are supported by both Vim and IdeaVim
set nu
set relativenumber
if has('ide')   " mappings and options that exist only in IdeaVim   map <leader>f <Action>(GotoFile)   map <leader>g <Action>(FindInPath)   map <leader>b <Action>(Switcher)
if &ide =~? 'intellij idea'     if &ide =~? 'community'       " some mappings and options for IntelliJ IDEA Community Edition     elseif &ide =~? 'ultimate'       " some mappings and options for IntelliJ IDEA Ultimate Edition     endif   elseif &ide =~? 'pycharm'     " PyCharm specific mappings and options   endif else   " some mappings for Vim/Neovim   nnoremap <leader>f <cmd>Telescope find_files<cr> endif

:gem: Contributing

The power of contributing drives IdeaVim :muscle:. Even small contributions matter!

See the contribution guide in CONTRIBUTING.md to start bringing your value to the project.

😎 In 2025, we launched a rewards program. See the guide for details.

Authors

See AUTHORS.md for a list of authors and contributors.

IdeaVim tips and tricks

• Use the power of IJ and Vim:

• Use your vim settings with IdeaVim. Put source ~/.vimrc in ~/.ideavimrc.
• Control the status bar icon via the ideastatusicon option.
• Not familiar with the default behaviour during a refactoring? See the idearefactormode option.

Let’s relax and have some fun now! Here are a few things we've found interesting during development and would like to share with you.

• There are no such commands as dd, yy, or cc. For example, dd is not a separate command for deleting the line,

• x, D, and & are not separate commands either. They are synonyms of dl, d$, and :s\r, respectively.

• You can read a post about how modes work in Vim and IdeaVim.

• Have you ever used U after dd? Don't even try.

• A lot of variables that refer to visual mode start with two uppercase letters, e.g. VIsualactive. Some examples.