The nteract/desktop repository is a modern toolkit designed for creating and interacting with Jupyter notebooks. Its primary purpose is to provide a fast and efficient desktop application for working with notebooks, offering features like instant startup, real-time synchronization across multiple windows and agents, and intelligent environment management. Built upon the `runtimelib` and `jupyter-protocol` crates, this project aims to deliver a seamless and powerful notebook experience.
At its core, the repository houses the `nteract` desktop application, built using Tauri and React. This application serves as the primary interface for users to create, edit, and manage their Jupyter notebooks. Alongside the desktop app, the repository includes the `runtimed` daemon, a background process responsible for crucial functionalities such as environment management, notebook synchronization, and kernel execution. The `runt` command-line interface (CLI) provides a means to interact with the daemon, manage kernels and notebooks, and perform various administrative tasks. Python bindings for the daemon are also included, offering developers the flexibility to integrate with the system using Python.
A significant feature of nteract is its integration with AI assistants through the MCP (Model-Code-Protocol) server. This server enables agents to interact with Jupyter notebooks, allowing them to execute code, read and write cells, manage dependencies, and collaborate with users in real-time. The repository provides tools for installing and utilizing plugins, such as the Claude Code plugin, which facilitates the connection between AI assistants and the notebook environment. The installation process is streamlined, offering both command-line options and a one-click installation path for users of the Claude Desktop application.
The repository's structure is well-defined, separating the UI code, Rust code, and Python packages into distinct directories. The `src/` directory contains shared UI components, hooks, and utilities, while the `apps/` directory houses the application entry points. The `crates/` directory contains the Rust code, including the CLI, daemon, and various supporting libraries. The `python/` directory contains Python packages, including the `runtimed` bindings and a stress-testing agent. This modular structure promotes code organization and maintainability.
The repository provides comprehensive documentation and development workflows. It outlines the necessary prerequisites, including Node.js, pnpm, and Rust, along with specific version requirements. Detailed instructions are provided for setting up the development environment and running various build and testing commands. The project utilizes `cargo xtask` for automating common development tasks, such as building the UI, running tests, linting code, and generating release builds. The documentation also covers contributing guidelines, including development workflows, architecture details, protocol specifications, and testing procedures. The project's commitment to open-source principles is evident through its BSD-3-Clause license, encouraging community contributions and collaboration. The project also provides a clear build order and common commands to streamline the development process.
