Skip to main content

Rich/Textual terminal viewer for Jupyter notebooks focused on copying code and text outputs

Project description

nbsee

PyPI version Python versions License

Simple CLI viewer for Jupyter notebooks focused on fast reading and easy copying of code and text outputs from the terminal.

nbsee screenshot

Features

  • Interactive terminal viewer for .ipynb files
  • Vim-style navigation between cells
  • Toggle focus between code/markdown and outputs
  • Copy code or outputs directly to clipboard
  • Visual selection mode to copy multiple cells
  • Search through inputs and outputs
  • Python syntax highlighting via Rich

Usage

  • nbsee notebook.ipynb — open an interactive viewer.

Key bindings

  • j/k: move to next/previous cell
  • Arrow Up/Down: scroll the view line-by-line
  • PageUp/PageDown: page scroll
  • Ctrl+u / Ctrl+d: half-page scroll up/down
  • Tab: toggle focus between input (code/markdown) and output (text/plain)
  • If a cell has no text output, Tab does nothing and shows a brief message.
  • y: copy the currently focused region to clipboard using xclip -selection clipboard
  • z: hide/show all outputs (fold outputs)
  • Shift+V: start/stop visual selection for inputs; use j/k to expand/shrink; y copies all selected code cells
  • /: search (inputs+outputs). Enter to submit, Esc cancels
  • n / N: next/prev match
  • gg / G: jump to first / last cell
  • q: quit

Notes

  • Clipboard support requires xclip (Linux/X11)
  • When no text output is available, copy shows an inline message

Install

uv (recommended)

uv is a fast Python package manager. Install it from here.

# Run without installing
uvx nbsee notebook.ipynb

# Or install permanently
uv tool install nbsee

pip

pip install nbsee

Development (uv)

  • Quick run without installing: uv run -m nbsee path/to/notebook.ipynb
  • Run tests: uv run pytest
  • Lint/format check: uv run ruff check . and uv run ruff format --check .
  • Build distributions: uv build
  • Release: push a tag like v0.1.0 to trigger .github/workflows/publish.yml (requires PyPI trusted publishing setup).
  • Install editable and use nbsee command:
    • Create venv: uv venv
    • Activate: source .venv/bin/activate
    • Install: uv pip install -e .
    • Run: nbsee path/to/notebook.ipynb

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbsee-0.1.1.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbsee-0.1.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file nbsee-0.1.1.tar.gz.

File metadata

  • Download URL: nbsee-0.1.1.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nbsee-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2b603428090640f39d3b2ffd613c6b767115b2a477acda22a5fb687f315aeb8d
MD5 d2837cacc0f25cece3c75e8f2f9e3396
BLAKE2b-256 90f860ed98bbbb560e67c537f023f403a5ee048b74f9db1375738e0137e52676

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbsee-0.1.1.tar.gz:

Publisher: publish.yml on AnakTeka/nbsee

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nbsee-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nbsee-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nbsee-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6047a5119c88ef0487e8377da33b06b084ea5e9ce0af89abba576f3c7e52e00
MD5 f5a45148886823ae29b8d83f5802780d
BLAKE2b-256 c7bf78de549de492b9fd328e1ffeb5919d5f26fd9c2aaf43a56bb09c7aeb90c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbsee-0.1.1-py3-none-any.whl:

Publisher: publish.yml on AnakTeka/nbsee

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page