Repolode
Submit
jupyterlab-contrib

jupyterlab-contrib/jupyterlab-quickopen

A JupyterLab extension that opens files by typing part of their name, via a quick open panel.

View on GitHub
Stars
89
Forks
15
Open issues
7
Last commit
2 days ago

What is it?

jupyterlab-quickopen adds a quick open panel to JupyterLab. Instead of navigating the file browser, you press Ctrl Shift P (Cmd P on macOS), type part of a filename, and pick the match from the list that appears.

The extension works with JupyterLab 3.2 and later, Jupyter Notebook 7, and JupyterLite. It indexes files either on the Jupyter Server or in the browser, the latter for JupyterLite-style setups. Files can be filtered with Jupyter Server settings such as hide_globs and allow_hidden, or with the extension's own exclude patterns.

An optional setting honors .gitignore files in the workspace, using gitwildmatch semantics on both the server and frontend. Global gitignore files and .git/info/exclude are not read.

Key features

  • 01Opens files by fuzzy-matching part of a filename from a quick open panel.
  • 02Default shortcut is Ctrl Shift P, or Cmd P on macOS, and can be remapped.
  • 03Excludes files using Jupyter Server settings or extension-level patterns.
  • 04Can honor .gitignore files in the workspace when enabled.
  • 05Supports client-side indexing for JupyterLite.

Use cases

  • Jumping to a notebook in a large project directory without browsing folders.
  • Using JupyterLab in a JupyterLite site where files are indexed in the browser.
  • Hiding build output or dependency folders from the file list via .gitignore.

Quick start

  1. 1

    Install the extension with pip

    pip install jupyterlab-quickopen
  2. 2

    Or install with conda or mamba from conda-forge

    conda install -c conda-forge jupyterlab-quickopen
  3. 3

    Start JupyterLab and press Ctrl Shift P (Cmd P on macOS) to open the quick open panel

Things to know

  • Frontend indexing mode and honoring .gitignore require extra Contents API configuration for hidden files.
  • Remote storage such as S3 is not supported; files must reside on a local filesystem to the Jupyter Server.

Topics

#jupyter#jupyterlab#jupyterlab-extension#file-search#notebook

FAQ

What is jupyterlab-quickopen?
A JupyterLab extension that opens files by typing part of their name, via a quick open panel. jupyterlab-quickopen adds a quick open panel to JupyterLab. Instead of navigating the file browser, you press Ctrl Shift P (Cmd P on macOS), type part of a filename, and pick the match from the list that appears.
Is jupyterlab-quickopen free to use? What license does it have?
jupyterlab-quickopen is open source under the BSD-3-Clause license. Check the license terms before using it in commercial products.
Is jupyterlab-quickopen still maintained?
Actively maintained. The last commit to jupyterlab-quickopen was on Nov 4, 2026.
What can I use jupyterlab-quickopen for?
Jumping to a notebook in a large project directory without browsing folders. Using JupyterLab in a JupyterLite site where files are indexed in the browser. Hiding build output or dependency folders from the file list via .gitignore.
How do I install jupyterlab-quickopen?
Install the extension with pip: pip install jupyterlab-quickopen Or install with conda or mamba from conda-forge: conda install -c conda-forge jupyterlab-quickopen Start JupyterLab and press Ctrl Shift P (Cmd P on macOS) to open the quick open panel
Where can I get jupyterlab-quickopen?
The source code and installation instructions are on GitHub: https://github.com/jupyterlab-contrib/jupyterlab-quickopen

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects