jupyterlab-quickopen

Quickly open a file in JupyterLab by typing part of its name

jupyterlab-quickopen-lab-4-update.webm

Compatibility

• Python >=3.8.x
• JupyterLab >=3.2
• Jupyter Server >=2.4
• Configurations where notebook documents and other files reside on a filesystem local to the Jupyter Server (which is the the default), not remote storage (e.g., S3)

Usage

After installing the extension, you can open the quick open panel by pressing Ctrl Shift P (or Cmd P on macOS). Start typing the name of the file you want to open, and the quick open panel will show a list of files that match the text you've typed.

jupyterlab-quickopen-lab-4-update.webm

The extension also works in Jupyter Notebook 7:

jupyterlab-quickopen-notebook-7.webm

Install

To install the extension with pip:

pip install jupyterlab-quickopen

With conda / mamba:

conda install -c conda-forge jupyterlab-quickopen

Configure

Using a custom Keyboard Shortcut

The default keyboard shortcut for opening the quickopen panel is Accel Ctrl P.

You can assign your own keyboard shortcut to show the quickopen panel at any time. Open the keyboard editor by clicking Settings → Advanced Settings Editor → Keyboard Shortcuts. Then enter JSON in the User Overrides text area like the following, adjusting the keys value to assign the shortcut of your choosing:

{
  "shortcuts": [
    {
      "command": "quickopen:activate",
      "keys": ["Accel Ctrl P"],
      "selector": "body",
      "title": "Activate Quick Open",
      "category": "Main Area"
    }
  ]
}

Patterns to Exclude

You can control which files to exclude from the quick open list using the Jupyter Server settings, JupyterLab settings, or both.

On the server side, use the ContentsManager.allow_hidden and/or ContentsManager.hide_globs settings. See the documentation about Jupyter Server options for details.

In the JupyterLab web app, open the Settings menu, click the Advanced Settings Editor option, select the Quick Open item in the Raw View sidebar, and enter JSON in the User Overrides text area to override the default values.

Development install

Note: You will need NodeJS to build the extension package.

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_quickopen directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_quickopen
# Rebuild extension Typescript source after making changes
jlpm 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 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 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

Releasing

See RELEASE

Acknowledgements

This extension was originally created by Peter Parente and was later moved to the jupyterlab-contrib GitHub organization.