jupyterlite
builds static JupyterLab sites that run entirely in the browser using
TLDR
Build JupyterLite site
SYNOPSIS
jupyter lite command [options]
DESCRIPTION
jupyter lite builds static JupyterLab sites that run entirely in the browser using WebAssembly. No server required—deploy to any static hosting.
build generates HTML, JavaScript, and assets in the output directory. Include notebooks with --contents to pre-populate the file browser. The resulting site runs JupyterLab with Pyodide kernel.
The Pyodide kernel executes Python in WebAssembly. Pre-install packages with --piplite-wheels or install at runtime via piplite. Many scientific Python packages are available.
serve starts a local HTTP server for testing. The build output can deploy to GitHub Pages, Netlify, or any static host. No backend infrastructure needed.
Configuration via jupyter_lite_config.json customizes settings, extensions, and build behavior. init creates template files.
PARAMETERS
--contents path
Path to content directory for notebooks.--output-dir path
Output directory for built site. Default: _output.--piplite-wheels path
Include pip wheels for piplite.--pyodide url
Custom Pyodide distribution URL.--port port
Port for serve command. Default: 8000.--lite-dir path
Source directory for JupyterLite files.--settings-overrides file
JSON file with settings overrides.--no-sourcemaps
Disable source maps in build.
COMMANDS
build
Build JupyterLite static site.serve
Serve built site locally.init
Initialize configuration files.status
Show build configuration status.clean
Remove build artifacts.archive
Create archive of built site.list
List addons and their status.
CAVEATS
Not all Python packages work in Pyodide (no native extensions without WASM builds). Performance is slower than native Python. Large notebooks may hit browser memory limits. Some JupyterLab extensions are incompatible.
HISTORY
JupyterLite was released in 2021 by the Project Jupyter team, leveraging Pyodide for browser-based Python. It enables sharing interactive notebooks without server infrastructure. The project grew from experiments with WebAssembly Python interpreters. JupyterLite enables educational content, documentation, and lightweight demos. Development continues alongside JupyterLab improvements.
SEE ALSO
jupyter-lab(1), pyodide(1), jupyter(1)
