Exciting release!Introducing "safe npm". Learn more
Socket
Log inDemoInstall

@axlair/jupyterlab_vim

Package Overview
Dependencies
9
Maintainers
10
Versions
9
Issues
File Explorer

Advanced tools

@axlair/jupyterlab_vim

Code cell vim bindings

    0.16.0latest
    GitHub

Version published
Maintainers
10
Weekly downloads
351
decreased by-30.08%

Weekly downloads

Readme

Source

jupyterlab-vim

Community fork of https://github.com/jwkvam/jupyterlab-vim updated for jupyterlab 2 and 3

Extension status Github Actions Status Binder npm version npm downloads PyPI Conda Version

Notebook cell vim bindings

jlabvim

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:

  1. Jupyterlab Command Mode
  2. Jupyterlab Edit Mode
    • Insert
    • Normal
    • Visual

Install

pip install jupyterlab-vim

or with conda/mamba:

mamba install -c conda-forge jupyterlab_vim

For Jupyterlab<3 see installing.md.

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

CommandAction
:w[rite]Save Notebook
:q[uit]Enter Jupyter command mode

Vim command bindings

ChordAction
Ctrl-O, UUndo Cell Action
-Split Cell at Cursor
Ctrl-O, -Split Cell at Cursor
Ctrl-O, DCut Cell
Ctrl-O, YCopy Cell
Ctrl-O, PPaste Cell
Ctrl-Shift-JExtend Marked Cells Below
Ctrl-Shift-KExtend Marked Cells Above
Ctrl-O, OInsert Cell Below
Ctrl-O, Ctrl-OInsert Cell Above
Ctrl-JSelect Cell Below
Ctrl-KSelect Cell Above
Ctrl-O, GSelect First Cell
Ctrl-O, Ctrl-GSelect Last Cell
Ctrl-EMove Cell Down
Ctrl-YMove Cell Up
Ctrl-O, Z, ZCenter Cell
Ctrl-GShow Tooltip
Command/Ctrl-1Code Cell Mode
Command/Ctrl-2Markdown Cell Mode
Command/Ctrl-3Raw Cell Mode
Shift-EscapeLeave Vim Mode
Escape, Ctrl-[Exit Vim Insert Mode

Jupyter command bindings

ChordAction
G, GSelect First Cell
Shift-GSelect Last Cell
D, DDelete Cell
Y, YYank (Copy) Cell
PPaste Cell
Shift-PPaste Cell Above
OInsert Cell
Shift-OInsert Cell Above
UUndo Cell Action
Ctrl-EMove Cells Down
Ctrl-YMove Cells Up
Z, ZCenter Cell
Z, CHide Code Cell
Z, OShow Code Cell
Z, MHide All Code Cells
Z, RShow All Code Cells

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 jupyter_packaging 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

Keywords

FAQs

Last updated on 12 Mar 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc