jupyterlab-vim¶
Notebook cell vim bindings
Modes¶
Like vim, Jupyterlab has a distinction between edit mode and command mode. Jupyterlab Command mode is when the cursor is not in a specific cell, and edit mode when typing in a cell.
This extension combines the Jupyterlab (Edit and Command) modes with the standard vim modes (Normal, Insert, Visual). So the set of modes now looks like:
Jupyterlab Command Mode
Jupyterlab Edit Mode
Insert
Normal
Visual
Install¶
pip install jupyterlab-vim
or with conda/mamba:
mamba install -c conda-forge jupyterlab_vim
Key Bindings¶
To learn how to modify key bindings see the modify-keybinds.md file.
Please note that all keys are lowercase unless Shift is explicitly indicated.
For example, Y, Y is two lowercase ys, Shift-Y, Y is one uppercase Y followed by a lowercase y.
Shortcuts this extension introduces:
Vim Ex commands¶
| Command | Action |
|---|---|
| :w[rite] | Save Notebook |
| :q[uit] | Enter Jupyter command mode |
Vim command bindings¶
| Chord | Action |
|---|---|
| Ctrl-O, U | Undo Cell Action |
| - | Split Cell at Cursor |
| Ctrl-O, - | Split Cell at Cursor |
| Ctrl-O, D | Cut Cell |
| Ctrl-O, Y | Copy Cell |
| Ctrl-O, P | Paste Cell |
| Ctrl-Shift-J | Extend Marked Cells Below |
| Ctrl-Shift-K | Extend Marked Cells Above |
| Ctrl-O, O | Insert Cell Below |
| Ctrl-O, Ctrl-O | Insert Cell Above |
| Ctrl-J | Select Cell Below |
| Ctrl-K | Select Cell Above |
| Ctrl-O, G | Select First Cell |
| Ctrl-O, Ctrl-G | Select Last Cell |
| Ctrl-E | Move Cell Down |
| Ctrl-Y | Move Cell Up |
| Ctrl-O, Z, Z | Center Cell |
| Ctrl-G | Show Tooltip |
| Command/Ctrl-1 | Code Cell Mode |
| Command/Ctrl-2 | Markdown Cell Mode |
| Command/Ctrl-3 | Raw Cell Mode |
| Shift-Escape | Leave Vim Mode |
| Escape, Ctrl-[ | Exit Vim Insert Mode |
Jupyter command bindings¶
| Chord | Action |
|---|---|
| G, G | Select First Cell |
| Shift-G | Select Last Cell |
| D, D | Delete Cell |
| Y, Y | Yank (Copy) Cell |
| P | Paste Cell |
| Shift-P | Paste Cell Above |
| O | Insert Cell |
| Shift-O | Insert Cell Above |
| U | Undo Cell Action |
| Ctrl-E | Move Cells Down |
| Ctrl-Y | Move Cells Up |
| Z, Z | Center Cell |
| Z, C | Hide Code Cell |
| Z, O | Show Code Cell |
| Z, M | Hide All Code Cells |
| Z, R | Show All Code Cells |
Switching between modes¶
From Command mode:
To enter Normal mode from Command mode, press Enter.
The extension blocks Shift+Esc from invoking browser commands, such as the browser task manager, by default. To disable the blocking behavior in Command mode, go to Settings menu → Settings Editor → Notebook Vim, and disable the “Override
Shift-Escbrowser shortcut in Jupyter Command mode” option.
From Normal mode:
To leave Normal mode to Command mode, several options are available:
Shift+Esc
Esc or Ctrl+[, if the “Enable
EscandCtrl-[leaving vim Normal mode to Jupyter Command mode” option is enabled (on by default). To disable the option, go to Settings menu → Settings Editor → Notebook Vim.
To enter Insert mode from Normal mode, use one of the insert commmands, such as i, I, a, A, o, O, c, C, s or S.
To enter Visual Mode from Normal mode, use one of the visual commands, such as v, V or Ctrl+V.
From Insert or Visual modes:
To leave Insert or Visual modes to Normal Mode, press Esc or Ctrl+[.
To leave Insert or Visual modes to Command Mode, press Shift+Esc.
Special Thanks¶
From @jwkvam:
I want to acknowledge Alisue and his excellent work creating vim bindings for Jupyter notebooks. I hope this extension can meet the high bar his work set.
@jkwvam is the original author of this extension - the original version can be seen here. When that version was not updated it was updated first by @axelfahy and then moved to this community organization.
Contributing¶
Contributions and feedback are most welcome!
Development install¶
Note: You will need NodeJS to build the extension package. To install with conda do:
conda install -c conda-forge nodejs
The jlpm command is JupyterLab’s pinned version of
yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.
# Clone the repo to your local environment
# Change directory to the jupyterlab_vim directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension’s source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
Uninstall¶
pip uninstall jupyterlab_vim