---
id: jupyterlab-chat
version: "0.24.0"
license: BSD 3-Clause License Copyright (c) 2024, Jupyter Development Team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the… (full text in the JSON record)
license_treatment: permissive
maintenance: active
---

# jupyterlab-chat — A chat extension based on shared documents

License: permissive · Maintenance: active · Downloads: 125.5K/mo

## What it is and what it does

jupyterlab_chat is a JupyterLab extension that embeds a chat widget into the notebook interface, built on a shared document architecture. It registers a YChat shared document type and associates it with a frontend chat widget, enabling users to communicate within their JupyterLab session. The extension requires JupyterLab >= 4.0.0 and Python >= 3.10, and works by pairing a server-side Python component with a frontend NPM extension.

The package is designed for collaborative notebook work, where multiple users can chat in real time through the same shared document infrastructure. Installation is straightforward via pip, though the extension must be enabled on both the server side and the frontend side to function properly.

Use it for:

- Enable in-notebook chat for collaborative data analysis sessions without switching between tools
- Provide real-time communication in shared JupyterLab environments for team-based research or education
- Integrate chat history with notebook documents for context-aware collaboration
- Support distributed teams working on Jupyter notebooks with synchronized messaging

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A JupyterLab extension that adds a chat interface to notebooks, using shared documents for real-time collaboration.

Yes, if you run JupyterLab >= 4.0.0 and want built-in chat for collaborative notebooks. Installation is low-friction, the extension is actively maintained, and it has no known security vulnerabilities. Verify that your deployment supports both the server extension and frontend extension installation before committing.

## Install

pip install jupyterlab-chat
uv add jupyterlab-chat
poetry add jupyterlab-chat

## Installing jupyterlab-chat

Before you install: Low friction installation as a pure Python wheel. Depends on jupyter-collaboration, jupyter-server, jupyter-ydoc, and pycrdt for shared document support. Active maintenance with recent releases.

License in practice: BSD 3-Clause License permits use, modification, and distribution with minimal restrictions; suitable for both open-source and commercial projects.

Quickstart:

pip install jupyterlab_chat
jupyter server extension list
jupyter labextension list

Requires JupyterLab >= 4.0.0 and Python >= 3.10; both server and frontend extensions must be enabled after installation

Verify before relying:

- Whether end-user deployment requires Node.js or additional system dependencies beyond the Python package
- Performance characteristics when handling large chat histories or concurrent users
- Whether the extension works with JupyterLab versions prior to 4.0.0

## Package facts

- License: BSD 3-Clause License Copyright (c) 2024, Jupyter Development Team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the… (full text in the JSON record) (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 125.5K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

jupyterlab chat extension, jupyter notebook chat, collaborative jupyter documents, jupyterlab real-time messaging, shared document chat widget, jupyter collaboration chat, jupyterlab communication, jupyter-extension, collaboration, real-time-sync

[View on SkillFed](https://skillfed.io/packages/jupyterlab-chat) · [View on PyPI](https://pypi.org/project/jupyterlab-chat/)