---
id: napari-console
version: "0.1.4"
license: BSD-3-Clause
license_treatment: permissive
maintenance: active
---

# napari-console — A plugin that adds a console to napari

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

## What it is and what it does

napari-console is a napari plugin that embeds an interactive console directly into the napari viewer interface. It lets you write and execute Python code while viewing and manipulating image data in real time, with access to the viewer, layers, and any variables from the calling scope.

The console automatically populates its namespace with variables from the enclosing Python frame—so if you call napari.run() from a script, those variables are immediately available in the console. This design is intended for exploratory workflows where you want to inspect layers, test operations, and adjust parameters without leaving the viewer. The package depends on IPython, ipykernel, qtconsole, and qtpy to provide the console UI and kernel infrastructure.

Use it for:

- Interactively explore and debug image processing workflows by accessing layers and viewer state directly from the console.
- Test operations on loaded images without restarting the viewer or writing separate scripts.
- Inspect and modify layer properties, metadata, or pixel data on the fly during analysis sessions.
- Prototype algorithms by iterating in the console while viewing results in real time.

## Worth the install?

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

Adds an interactive Python console panel to napari, allowing you to inspect and manipulate data and layers directly from within the viewer.

Yes, if you use napari for interactive image analysis and want a built-in Python console. The package is actively maintained, has low install friction, carries a permissive license, and integrates with napari's plugin system. The 303-day gap since the last release is a minor signal to monitor, but the repository remains active. No known vulnerabilities.

## Install

pip install napari-console
uv add napari-console
poetry add napari-console

## Installing napari-console

Before you install: Low friction installation with a pure-Python wheel and only four runtime dependencies. Repository is active with a recent commit on 2026-08-03, though 303 days have passed since the last release.

License in practice: Distributed under BSD-3-Clause (permissive), so you can use, modify, and redistribute the package freely with minimal restrictions.

Quickstart:

pip install napari-console

# Then in your napari script:
import napari

viewer = napari.imshow(image_data)
napari.run()  # Console is now available in the viewer

Requires Python >= 3.10 and a working napari installation with Qt support (via qtpy).

Verify before relying:

- Whether the console namespace behavior (accessing enclosing frame variables) works reliably across different embedding scenarios beyond the NAPARI_EMBED environment variable.
- Current test coverage and whether it meets the project's own standards mentioned in the contributing guidelines.
- Specific use cases and workflows where this console integration provides the most value over standalone napari usage.

## Package facts

- License: BSD-3-Clause (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 178.9K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

napari console plugin, interactive python shell napari, napari viewer console, image viewer python repl, napari debugging console, napari data inspection, napari interactive terminal, napari-plugin, interactive-analysis, image-viewer

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