# jupyterlite/jupyterlite architecture

> Architecture diagram of the GitHub repository jupyterlite/jupyterlite, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jupyterlite/jupyterlite
- Repository: https://github.com/jupyterlite/jupyterlite

## Overview

JupyterLite is a browser-native Jupyter distribution, paired with Python tooling for assembling and serving a static deployment. The user workflow is to open a browser interface, use in-browser kernel and file services to work with notebooks, and save or export results locally. The graph also includes deployment configuration and addon stages. README statements and source-index references establish several capability links; where sampled code does not show runtime wiring, uncertain connections are omitted or marked unverified.

Main entry points: [`app/index.template.js`](https://github.com/jupyterlite/jupyterlite/blob/main/app/index.template.js) (JupyterLab interface), [`packages/application-extension/src/index.tsx`](https://github.com/jupyterlite/jupyterlite/blob/main/packages/application-extension/src/index.tsx) (Core app extensions), [`py/jupyterlite-core/jupyterlite_core/app.py`](https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/app.py) (Build CLI), [`packages/services/src/contents/drive.ts`](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/contents/drive.ts) (Contents drive)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_deploy["Build and deployment"]
  node_static_output["Static site output"]
end

subgraph group_frontend["Browser application"]
  node_lab_ui["JupyterLab interface<br/>[index.template.js]"]
  node_notebook_ui["Notebook interface<br/>[index.ts]"]
  node_repl_ui["Code console<br/>[index.ts]"]
  node_plugin_setup["Plugin bootstrap<br/>[index.template.js]"]
  node_app_extension["Core app extensions<br/>[index.tsx]"]
  node_app_router["Application router<br/>[router.ts]"]
  node_extension_manager["Extension manager"]
  node_kernel_status["Kernel status UI<br/>[kernelstatus.tsx]"]
end

subgraph group_services["Browser services"]
  node_contents["Contents drive<br/>[drive.ts]"]
  node_kernel_runtime["Kernel client<br/>[client.ts]"]
  node_kernel_specs["Kernel specs<br/>[kernelspecs.ts]"]
  node_sessions["Session client<br/>[client.ts]"]
  node_exports["Notebook export<br/>[manager.ts]"]
  node_browser_storage[("Browser storage<br/>[index.ts]")]
end

subgraph group_python["Python build tooling"]
  node_python_cli["Build CLI<br/>[app.py]"]
  node_build_manager["Addon task manager<br/>[manager.py]"]
  node_addon_system["Build addons"]
  node_build_config["Build configuration<br/>[config.py]"]
end

node_user(("User"))
node_static_host["Static host"]

node_user -->|"uses"| node_lab_ui
node_user -->|"uses"| node_notebook_ui
node_lab_ui -->|"starts through"| node_plugin_setup
node_plugin_setup -->|"loads"| node_app_extension
node_lab_ui -.->|"offers"| node_repl_ui
node_plugin_setup -.->|"configures extensions"| node_extension_manager
node_app_extension -->|"provides routing"| node_app_router
node_app_extension -->|"provides status UI"| node_kernel_status
node_user -->|"opens and edits files"| node_contents
node_contents -.->|"persists locally"| node_browser_storage
node_user -->|"runs code"| node_kernel_runtime
node_kernel_runtime -->|"selects factory"| node_kernel_specs
node_user -->|"manages sessions"| node_sessions
node_user -->|"exports notebook"| node_exports
node_exports -->|"reads notebook"| node_contents
node_user -->|"builds deployment"| node_python_cli
node_python_cli -->|"initializes manager"| node_build_manager
node_build_manager -->|"loads addons"| node_addon_system
node_python_cli -->|"uses config"| node_build_config
node_addon_system -.->|"generates site"| node_static_output
node_static_output -->|"is deployed to"| node_static_host
node_static_host -->|"serves application"| node_lab_ui

click node_lab_ui "https://github.com/jupyterlite/jupyterlite/blob/main/app/index.template.js"
click node_notebook_ui "https://github.com/jupyterlite/jupyterlite/blob/main/packages/notebook-application-extension/src/index.ts"
click node_repl_ui "https://github.com/jupyterlite/jupyterlite/blob/main/packages/repl-extension/src/index.ts"
click node_plugin_setup "https://github.com/jupyterlite/jupyterlite/blob/main/app/index.template.js"
click node_app_extension "https://github.com/jupyterlite/jupyterlite/blob/main/packages/application-extension/src/index.tsx"
click node_app_router "https://github.com/jupyterlite/jupyterlite/blob/main/packages/application/src/router.ts"
click node_extension_manager "https://github.com/jupyterlite/jupyterlite/blob/main/packages/apputils/src/extensionmanager.ts"
click node_kernel_status "https://github.com/jupyterlite/jupyterlite/blob/main/packages/apputils-extension/src/kernelstatus.tsx"
click node_contents "https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/contents/drive.ts"
click node_kernel_runtime "https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/kernel/client.ts"
click node_kernel_specs "https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/kernel/kernelspecs.ts"
click node_sessions "https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/session/client.ts"
click node_exports "https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/nbconvert/manager.ts"
click node_browser_storage "https://github.com/jupyterlite/jupyterlite/blob/main/packages/services-extension/src/index.ts"
click node_python_cli "https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/app.py"
click node_build_manager "https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/manager.py"
click node_addon_system "https://github.com/jupyterlite/jupyterlite/tree/main/py/jupyterlite-core/jupyterlite_core/addons"
click node_build_config "https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/config.py"
click node_static_output "https://github.com/jupyterlite/jupyterlite/tree/main/py/jupyterlite-core/jupyterlite_core/addons"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_static_output,node_user toneBlue
class node_lab_ui,node_notebook_ui,node_repl_ui,node_plugin_setup,node_app_extension,node_app_router,node_extension_manager,node_kernel_status toneAmber
class node_contents,node_kernel_runtime,node_kernel_specs,node_sessions,node_exports,node_browser_storage toneMint
class node_python_cli,node_build_manager,node_addon_system,node_build_config toneRose
class node_static_host toneIndigo
```

## Components

### Build and deployment

- [Static site output](https://github.com/jupyterlite/jupyterlite/tree/main/py/jupyterlite-core/jupyterlite_core/addons): `py/jupyterlite-core/jupyterlite_core/addons`

### Browser application

- [JupyterLab interface](https://github.com/jupyterlite/jupyterlite/blob/main/app/index.template.js): `app/index.template.js`
- [Notebook interface](https://github.com/jupyterlite/jupyterlite/blob/main/packages/notebook-application-extension/src/index.ts): `packages/notebook-application-extension/src/index.ts`
- [Code console](https://github.com/jupyterlite/jupyterlite/blob/main/packages/repl-extension/src/index.ts): `packages/repl-extension/src/index.ts`
- [Plugin bootstrap](https://github.com/jupyterlite/jupyterlite/blob/main/app/index.template.js): `app/index.template.js`
- [Core app extensions](https://github.com/jupyterlite/jupyterlite/blob/main/packages/application-extension/src/index.tsx): `packages/application-extension/src/index.tsx`
- [Application router](https://github.com/jupyterlite/jupyterlite/blob/main/packages/application/src/router.ts): `packages/application/src/router.ts`
- [Extension manager](https://github.com/jupyterlite/jupyterlite/blob/main/packages/apputils/src/extensionmanager.ts): `packages/apputils/src/extensionmanager.ts`
- [Kernel status UI](https://github.com/jupyterlite/jupyterlite/blob/main/packages/apputils-extension/src/kernelstatus.tsx): `packages/apputils-extension/src/kernelstatus.tsx`

### Browser services

- [Contents drive](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/contents/drive.ts): `packages/services/src/contents/drive.ts`
- [Kernel client](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/kernel/client.ts): `packages/services/src/kernel/client.ts`
- [Kernel specs](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/kernel/kernelspecs.ts): `packages/services/src/kernel/kernelspecs.ts`
- [Session client](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/session/client.ts): `packages/services/src/session/client.ts`
- [Notebook export](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services/src/nbconvert/manager.ts): `packages/services/src/nbconvert/manager.ts`
- [Browser storage](https://github.com/jupyterlite/jupyterlite/blob/main/packages/services-extension/src/index.ts): `packages/services-extension/src/index.ts`

### Python build tooling

- [Build CLI](https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/app.py): `py/jupyterlite-core/jupyterlite_core/app.py`
- [Addon task manager](https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/manager.py): `py/jupyterlite-core/jupyterlite_core/manager.py`
- [Build addons](https://github.com/jupyterlite/jupyterlite/tree/main/py/jupyterlite-core/jupyterlite_core/addons): `py/jupyterlite-core/jupyterlite_core/addons`
- [Build configuration](https://github.com/jupyterlite/jupyterlite/blob/main/py/jupyterlite-core/jupyterlite_core/config.py): `py/jupyterlite-core/jupyterlite_core/config.py`

### Other components

- **User**
- **Static host**

## Connections

- User → JupyterLab interface: uses
- User → Notebook interface: uses
- JupyterLab interface → Plugin bootstrap: starts through (evidence: `app/index.template.js`)
- Plugin bootstrap → Core app extensions: loads (evidence: `app/index.template.js`)
- JupyterLab interface → Code console: offers
- Plugin bootstrap → Extension manager: configures extensions
- Core app extensions → Application router: provides routing (evidence: `packages/application-extension/src/index.tsx`)
- Core app extensions → Kernel status UI: provides status UI
- User → Contents drive: opens and edits files
- Contents drive → Browser storage: persists locally
- User → Kernel client: runs code
- Kernel client → Kernel specs: selects factory (evidence: `packages/services/src/kernel/client.ts`)
- User → Session client: manages sessions
- User → Notebook export: exports notebook (evidence: `packages/services/src/nbconvert/manager.ts`)
- Notebook export → Contents drive: reads notebook (evidence: `packages/services/src/nbconvert/manager.ts`)
- User → Build CLI: builds deployment
- Build CLI → Addon task manager: initializes manager (evidence: `py/jupyterlite-core/jupyterlite_core/app.py`)
- Addon task manager → Build addons: loads addons (evidence: `py/jupyterlite-core/jupyterlite_core/manager.py`)
- Build CLI → Build configuration: uses config (evidence: `py/jupyterlite-core/jupyterlite_core/app.py`)
- Build addons → Static site output: generates site
- Static site output → Static host: is deployed to
- Static host → JupyterLab interface: serves application
