nteract is a local-first notebook environment where humans, kernels, and AI agents can work against the same live document. It ships as a native desktop app with instant startup, realtime sync across windows and programmatic clients, and managed local environments.
Built on jupyter-zmq-client and jupyter-protocol.
Download the latest release from GitHub Releases.
Linux desktop users should use the AppImage from GitHub Releases, or run
scripts/install-linux-release to install the AppImage plus CLI/daemon and
the per-user systemd service in one step. DEB/RPM/APT installs are not
currently supported because runtimed is a per-user daemon managed by the app
and CLI, not by system package-manager scripts.
For remote Linux workstations (Outerbounds, JupyterHub) that offer compute to hosted notebooks, use the headless one-liner — see Remote workstations:
curl --proto '=https' --tlsv1.2 -sSfL \
https://raw.githubusercontent.com/nteract/nteract/main/scripts/install-linux-release | \
bash -s -- --headlessThe desktop app bundles everything — runt CLI and runtimed daemon.
The runt CLI and runtimed Python bindings ship with the app and stay up to date automatically. For nightly builds, use runt-nightly instead.
| Component | Description |
|---|---|
nteract |
Desktop notebook editor (Tauri + React) |
runtimed |
Background daemon — environment pools, notebook sync, kernel execution |
runt |
CLI for managing kernels, notebooks, and the daemon |
runtimed (Python) |
Python bindings for the daemon (ships with the app) |
nteract stores notebook content in an Automerge-backed document and keeps live kernel state in an explicit runtime state document. The daemon owns kernel processes, execution queues, output capture, and the write path for execution results.
Execution requests name a synced cell_id; the daemon reads the cell source from the shared document, records queue and status changes in runtime state, and writes outputs through the same model. The desktop app, CLI, MCP server, and agent clients use that path, so programmatic control observes the same notebook state a human is editing.
The nteract MCP server connects AI assistants to Jupyter notebooks through the daemon. Agents can run code, read and write cells, manage dependencies, and collaborate with humans in real-time — watching the notebook update live in the desktop app while the agent works.
codex plugin marketplace add nteract/agent-plugins
Restart Codex, then open the plugin directory, choose the nteract marketplace, and install nteract.
The distribution repository also includes a nightly plugin entry for pre-release builds.
/plugin marketplace add nteract/agent-plugins
/plugin install nteract@nteract
Pin a specific version:
/plugin install nteract@nteract --ref v2.3.0
The plugin ships the right nteract-mcp binary for your platform (macOS arm64/x64, Linux x64, Windows x64) — no separate install needed. main of nteract/agent-plugins always points at the latest stable release.
For pre-release builds (updated daily):
/plugin install nightly@nteract
If you use the nteract desktop app with Claude Desktop, there's a one-click install path. In the menu bar, choose nteract → Install Extension for Claude...
The desktop app builds a .mcpb bundle at runtime (manifest, icons, nteract-mcp binary) and hands it to Claude Desktop, which prompts you to confirm the install. Requires the nteract desktop app; Claude Desktop picks up the bundle from there.
# Open a notebook
runt notebook path/to/notebook.ipynb
# MCP server for notebook automation
runt mcp
# Daemon management
runt daemon status
runt daemon logs -fList open notebooks with kernel and environment info:
$ runt notebooks
╭──────────────────────────────────────┬────────┬──────────────┬────────┬───────╮
│ NOTEBOOK │ KERNEL │ ENV │ STATUS │ PEERS │
├──────────────────────────────────────┼────────┼──────────────┼────────┼───────┤
│ ~/notebooks/blobstore.ipynb │ python │ uv:inline │ idle │ 1 │
│ d4c441d3-d862-4ab0-afe6-ff9145cc2f3d │ python │ uv:prewarmed │ idle │ 1 │
╰──────────────────────────────────────┴────────┴──────────────┴────────┴───────╯
nteract/nteract
├── src/ # Shared UI code (React components, hooks, utilities)
│ ├── bindings/ # TypeScript types generated from Rust (ts-rs)
│ ├── components/
│ │ ├── ui/ # shadcn primitives (button, dialog, etc.)
│ │ ├── cell/ # Notebook cell components
│ │ ├── outputs/ # Output renderers (stream, error, display data)
│ │ ├── editor/ # CodeMirror editor
│ │ ├── isolated/ # Iframe security isolation (IsolatedFrame, CommBridgeManager)
│ │ └── widgets/ # ipywidgets controls
│ ├── hooks/ # Shared hooks (useSyncedSettings, useTheme)
│ ├── isolated-renderer/ # Code that runs inside isolated iframes
│ ├── lib/ # Shared utilities (cn(), dark-mode, error-boundary)
│ └── styles/ # Global stylesheets
├── apps/ # App entry points
│ └── notebook/ # Notebook Tauri frontend
├── crates/ # Rust code
│ ├── runt/ # CLI binary
│ ├── runtimed/ # Background daemon
│ ├── runtimed-py/ # Python bindings for the daemon
│ ├── runtimed-wasm/ # WASM Automerge bindings for frontend (same automerge crate as daemon)
│ ├── notebook/ # Notebook Tauri app
│ ├── notebook-doc/ # Shared Automerge document operations (cells, metadata, sync)
│ ├── notebook-protocol/ # Notebook wire protocol types
│ ├── notebook-sync/ # Notebook sync layer
│ ├── kernel-launch/ # Shared kernel launching API
│ ├── kernel-env/ # Environment progress reporting
│ ├── runt-mcp/ # Rust-native MCP server for notebook interaction
│ ├── runt-trust/ # Notebook trust extraction
│ ├── runt-workspace/ # Workspace detection utilities
│ ├── runtimed-client/ # Shared client library for daemon communication
│ ├── repr-llm/ # LLM-friendly text summaries of visualization specs
│ ├── xtask/ # Build automation tasks
│ └── mcp-supervisor/ # nteract-dev MCP server (proxies runt mcp + adds dev tools)
├── python/ # Python packages
│ ├── runtimed/ # PyPI: runtimed (Python bindings for daemon)
│ ├── nteract/ # PyPI: nteract (thin wrapper that launches `runt mcp`)
│ └── gremlin/ # Stress-testing agent for nteract notebooks (not published)
| Tool | Version | Install |
|---|---|---|
| Node.js | 20+ | https://nodejs.org |
| pnpm | 10.12+ | corepack enable |
| Rust | 1.94.0 | https://rustup.rs (version managed by rust-toolchain.toml) |
Linux only: Install GTK/WebKit dev libraries:
sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev libxdo-dev \
libssl-dev libayatana-appindicator3-dev librsvg2-devcargo xtask dev| Workflow | Command | Use when |
|---|---|---|
| One-shot setup + dev | cargo xtask dev |
First-time setup plus daemon + app in one command |
| Hot reload | cargo xtask notebook |
Iterating on React UI |
| Standalone Vite | cargo xtask vite |
Multi-window testing (Vite survives window closes) |
| Attach to Vite | cargo xtask notebook --attach |
Connect Tauri to already-running Vite |
| Debug build | cargo xtask build |
Full debug build (frontend + rust) |
| E2E debug build | cargo xtask e2e build |
Debug build with built-in WebDriver server |
| Rust-only build | cargo xtask build --rust-only |
Rebuild rust, reuse existing frontend |
| Run bundled | cargo xtask run notebook.ipynb |
Run standalone binary |
| Lint (check) | cargo xtask lint |
Check formatting and linting across Rust, JS/TS, Python |
| Lint (fix) | cargo xtask lint --fix |
Auto-fix formatting and linting |
| Dev daemon | cargo xtask dev-daemon |
Run per-worktree dev daemon |
| Artifact status | cargo xtask artifacts status |
Check generated WASM, renderer, and MCP widget artifacts |
| Install nightly (Linux/headless) | ./scripts/install-nightly |
Build + install runtimed + runt + nteract-mcp as the local nightly. Refuses on macOS and when an app bundle is installed. |
| Release .app | cargo xtask build-app |
Testing app bundle locally |
| Release DMG | cargo xtask build-dmg |
Distribution (usually CI) |
| Generate icons | cargo xtask icons [source.png] |
Generate icon variants from source image |
cargo xtask dev runs the first-time bootstrap (pnpm install + cargo xtask build),
starts the per-worktree dev daemon, waits for it to be ready, and then launches the
notebook app. For repeat launches, use cargo xtask dev --skip-install --skip-build.
The UI must be built before Rust because crates/notebook embeds assets from apps/notebook/dist/ via Tauri.
pnpm build # Build notebook UI
cargo test # Run Rust tests
pnpm test:run # Run JS tests
cargo xtask artifacts status # Check generated artifact readiness
cargo xtask artifacts ensure runtime # Rebuild only runtimed-wasm when needed
cargo fmt # Format Rust
vp check --fix # Lint + format JS/TS
cargo clippy --all-targets -- -D warnings # Lint RustThe underlying Rust libraries are published to crates.io:
jupyter-protocol— Jupyter messaging protocoljupyter-zmq-client- Jupyter kernel interactions over ZeroMQnbformat— Notebook parsing
See AGENTS.md for the subsystem map and development guidance. Key entry points:
crates/runtimed/AGENTS.md— architecture, daemon, state ownershipapps/notebook/src/AGENTS.md— frontend architecturecrates/notebook-wire/AGENTS.md— wire protocolcargo xtask help— all build commands
BSD-3-Clause