Compatibility

Use this page before adding Lens to an existing environment or following an agent API from the hosted documentation.

Python and marimo

Component	Supported contract
Python	3.10 through 3.14
marimo	0.24.0 or newer
marimo-lens	Install a tagged release from PyPI for released behavior.

The package declares no upper marimo version bound. Lens uses public notebook rendering plus private marimo runtime, control-state, UI-registry, and code-mode APIs. Run the Lens checks again after upgrading marimo when your workflow depends on agent connection, graph context, control values, or cell-output capture.

Browser

Lens requires a browser with JavaScript and current implementations of these Web Platform APIs:

• Document Object Model events and observation.
• Canvas and PNG encoding.
• Web Crypto hashing.
• Blob URLs.
• Abort signals.
• Same-origin access for embedded documents that Lens must inspect or capture.

Lens supports keyboard and pointer interaction, coarse-pointer layouts, reduced-motion preferences, forced colors, open shadow roots, and accessible same-origin iframe documents. A cross-origin iframe remains outside the document boundary and can block image capture.

Code-mode agents

The agent workflow requires an integration that can execute Python in the live marimo kernel. Lens calls this environment code mode. The same kernel must contain the installed marimo-lens package and the mounted Lens instance.

The package registers marimo_lens.agent in marimo's marimo.agent.capability entry-point group. An agent host can discover that capability, read the packaged Agent Skill, and call connect() inside the live kernel.

marimo Pair is one optional code-mode integration. Installing its Agent Skill with npx skills add requires Node.js, the npx command, network access, and an agent host that supports Agent Skills.

Hosted docs and released packages

The hosted documentation is built from the repository's main branch. PyPI publishes tagged releases. The two surfaces can differ between a merge and the next release tag.

Check the installed package version:

from marimo_lens import __version__

print(__version__)

Use the source tree at the matching tag when you need the exact contract for an installed release. To test the current main documentation against current source, create a disposable environment from the repository:

uvx --with "marimo-lens @ git+https://github.com/marimo-team/marimo-lens.git@main" \
  marimo edit notebook.py

The command requires Git and network access. Prefer a tagged PyPI release for repeatable projects.

Read Getting started for the normal PyPI path. Read Troubleshooting when capability discovery, browser capture, or runtime access fails after an upgrade.