https://github.com/davidbrochart/nbterm

Jupyter Notebooks in the terminal.
https://github.com/davidbrochart/nbterm

Last synced: 8 months ago
JSON representation

Jupyter Notebooks in the terminal.

• Host: GitHub
• URL: https://github.com/davidbrochart/nbterm
• Owner: davidbrochart
• License: mit
• Created: 2021-04-05T18:28:59.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-10T15:15:27.000Z (over 2 years ago)
• Last Synced: 2025-04-01T10:13:11.734Z (8 months ago)
• Language: Python
• Homepage:
• Size: 49.8 KB
• Stars: 761
• Watchers: 15
• Forks: 37
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - davidbrochart/nbterm - Jupyter Notebooks in the terminal. (others)
• StarryDivineSky - davidbrochart/nbterm
• awesome-cli-apps-in-a-csv - nbterm - Jupyter Notebooks in the terminal. (<a name="programming"></a>Programming)
• awesome-cli-apps - nbterm - Jupyter Notebooks in the terminal. (<a name="programming"></a>Programming)

README

          
[![Build Status](https://github.com/davidbrochart/nbterm/workflows/CI/badge.svg)](https://github.com/davidbrochart/nbterm/actions)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# nbterm

Lets you view, edit and execute Jupyter Notebooks in the terminal.

**WARNING**: [jpterm](https://github.com/davidbrochart/jpterm) is the successor of nbterm, which is not maintained anymore.

## Install

Using pip:

```

pip install nbterm

```

Using conda:

```

mamba install nbterm -c conda-forge

```

You will also need a kernel, e.g. `ipykernel` or `xeus-python` for Python, `xeus-cling` for C++.

## Usage

Open an interactive notebook:

```

$ nbterm my_notebook.ipynb

```

Run a notebook in batch mode:

```

$ nbterm --run my_notebook.ipynb

```

## Key bindings

There are two modes: edit mode, and command mode.

- `enter`: enter the edit mode, allowing to type into the cell.

- `esc`: exit the edit mode and enter the command mode.

In command mode:

- `up`: select cell above.

- `down`: select cell below.

- `ctrl-up`: move cell above.

- `ctrl-down`: move cell below.

- `a`: insert cell above.

- `b`: insert cell below.

- `x`: cut the cell.

- `c`: copy the cell.

- `ctrl-v`: paste cell above.

- `v`: paste cell below.

- `o`: set as code cell.

- `r`: set as raw cell.

- `m`: set as Markdown cell.

- `l`: clear cell outputs.

- `ctrl-e`: run cell.

- `ctrl-r`: run cell and select below.

- `ctrl-s`: save.

- `ctrl-q`: exit.

- `ctrl-h`: show help.