Euporie Notebook

In euporie’s notebooks editor, you can interactively edit and run Jupyter notebooks from the comfort of your terminal.

Euporie supports most of the features of Jupyter Notebooks, so users of Jupyter should find it intuitive to use.

User Guide

Creating a New Notebook

To create a new notebook from the command line, launch euporie with the desired new notebook file path as an argument:

$ euporie-notebook ./my-new-notebook.ipynb

To create a new notebook from within the TUI editor, select File ‣ New in the menus, or press the Ctrl+N keyboard shortcut.

Editing a Cell

The currently selected cell can be edited by pressing Enter, which will enter Edit Mode. This focuses the cell’s input text area, and allows you to edit the cell’s content.

To exit Edit Mode, you can press the Esc key when you are done editing, or you can run the cell.

Running a Cell

To run the currently selected cell, you can press Ctrl+Enter (providing your terminal supports this key-binding; you can also use Ctrl+e).

Alternatively, you can select Run ‣ Run selected cells in the menu.

Opening an Existing Notebook

To open a notebook from the command line, launch euporie with the notebook file path as an argument:

$ euporie-notebook ./my-notebook.ipynb

To open a notebook from within the TUI editor, select File ‣ Open in the menus, or press the Ctrl+O keyboard shortcut. Enter the path of the notebook you wish to open into the file open dialog and press OK.

Adding a new cell

You can press b to add a new cell below the currently selected cell. You can also press a to add a new cell above the currently selected cell.

Navigating the Notebook

When a notebook is open, the currently selected cell is highlighted with a blue border. The selected cell can be changed using the Up and Down arrow keys (or j and k). Selecting a cell which is not currently visible will automatically scroll it into view.

You can select the first or last cell the the Home or End keys.

The notebook can be scrolled up and down one line at a time using the [ and ] keys respectively. Use the { and } keys to scroll up or down by 5 lines. You can also scroll the notebook with the mouse wheel, or by clicking on the notebook’s scroll bar.

Saving a Notebook

To save a notebook, press Ctrl+S or navigate to File ‣ Save Notebook in the menus.

Closing a Notebook

To save a notebook, press Ctrl+W or navigate to File ‣ Close File Notebook in the menus.

Changing a Cell’s Type

To change the currently selected cells to:

code cells, press y;
markdown cells, press m;
raw cells, press r.

Restarting the Kernel

To restart the kernel, navigate to Kernel ‣ Restart kernel in the menus and select Yes in the confirmation dialog.

Alternatively, press the 0 0 keyboard shortcut.

Changing the Kernel

To change a notebook’s kernel, navigate to Kernel ‣ Change kernel in the menus.

Setting the Color Scheme

To change the color scheme, navigate to Settings ‣ Color Scheme in the menus, then select the color scheme name you want to use.

To configure the custom color scheme, use the custom_foreground_color and custom_background_color configuration options.

Setting the Syntax Theme

To change the syntax theme, navigate to Settings ‣ Syntax Theme in the menus, then select the syntax theme you want to use.

Using the Command Palette

Practically every action in euporie (including all of those listed above) can be performed through the command palette, which can be summoned using Ctrl+Space. You can type in the input box to search for a command, use the arrow keys to select a command from the list, and press Enter to run the selected command.

Command Line Interface

Usage

$ euporie-notebook [-h] [--log-file [str]]
                        [--log-level {debug,info,warning,error,critical}]
                        [--log-config loads]
                        [--clipboard {external,internal,terminal}]
                        [--edit-mode {micro,emacs,vi}] [--tab-size int]
                        [--terminal-polling-interval float]
                        [--formatters loads]
                        [--syntax-highlighting | --no-syntax-highlighting]
                        [--syntax-theme str] [--color-depth {1,4,8,24}]
                        [--color-scheme {default,inverse,light,dark,black,white,custom}]
                        [--custom-background-color str]
                        [--custom-foreground-color str] [--accent-color str]
                        [--custom-styles loads] [--key-bindings loads]
                        [--graphics {none,sixel,kitty,kitty-unicode,iterm}]
                        [--force-graphics | --no-force-graphics]
                        [--enable-language-servers | --lsp | --no-enable-language-servers | --no-lsp]
                        [--language-servers loads]
                        [--set-cursor-shape | --no-set-cursor-shape]
                        [--cursor-blink | --no-cursor-blink]
                        [--recent-files [UPath ...]]
                        [--warn-venv | --no-warn-venv]
                        [--backup-on-save | --no-backup-on-save]
                        [--kernel-name str]
                        [--record-cell-timing | --no-record-cell-timing]
                        [--show-remote-inputs | --no-show-remote-inputs]
                        [--show-remote-outputs | --no-show-remote-outputs]
                        [--wrap-cell-outputs | --no-wrap-cell-outputs]
                        [--text-output-limit int]
                        [--show-file-icons | --no-show-file-icons]
                        [--show-hidden-files | --no-show-hidden-files]
                        [--line-numbers | --no-line-numbers]
                        [--relative-line-numbers | --no-relative-line-numbers]
                        [--autoformat | --no-autoformat]
                        [--autocomplete | --no-autocomplete]
                        [--autosuggest {smart,simple,none}]
                        [--show-status-bar | --no-show-status-bar]
                        [--show-shadows | --no-show-shadows]
                        [--tab-mode {stack,tile_horizontally,tile_vertically}]
                        [--always-show-tab-bar | --no-always-show-tab-bar]
                        [--background-pattern {0,1,2,3,4,5}]
                        [--background-character str]
                        [--run-after-external-edit | --no-run-after-external-edit]
                        [--run | --no-run]
                        [--show-top-bar | --no-show-top-bar]
                        [--show-side-bar | --no-show-side-bar]
                        [--side-bar-width int]
                        [--side-bar-panel-index <lambda>]
                        [UPath ...]

Positional Arguments

<UPath> ...: List of file names to open

Optional Arguments

-h, --help: show this help message and exit

--version, -V: ==SUPPRESS==

--log-file <str>: File path for logs

--log-level {debug,info,warning,error,critical}: Set the log level

--log-level-stdout {debug,info,warning,error,critical}: ==SUPPRESS==

--log-config <loads>: Additional logging configuration

--clipboard {external,internal,terminal}: The preferred clipboard access method

--edit-mode {micro,emacs,vi}: Key-binding mode for text editing

--tab-size <int>: Spaces per indentation level

--terminal-polling-interval <float>: Time between terminal colour queries

--formatters <loads>: List of external code formatters

--syntax-highlighting, --no-syntax-highlighting: Syntax highlighting

--syntax-theme <str>: Syntax highlighting theme

--color-depth {1,4,8,24}: The color depth to use

--multiplexer-passthrough, --no-multiplexer-passthrough: ==SUPPRESS==

--color-scheme {default,inverse,light,dark,black,white,custom}: The color scheme to use

--custom-background-color <str>, --custom-bg-color <str>, --bg <str>: Background color for “Custom” color theme

--custom-foreground-color <str>, --custom-fg-color <str>, --fg <str>: Foreground color for “Custom” color theme

--accent-color <str>: Accent color to use in the app

--custom-styles <loads>: Additional style settings

--key-bindings <loads>: Additional key binding definitions

--graphics {none,sixel,kitty,kitty-unicode,iterm}: The preferred graphics protocol

--force-graphics, --no-force-graphics: Force use of specified graphics protocol

--enable-language-servers, --lsp, --no-enable-language-servers, --no-lsp: Enable language server support

--language-servers <loads>: Language server configurations

--set-cursor-shape, --no-set-cursor-shape: Whether to set the shape of the cursor depending on the editing mode

--cursor-blink, --no-cursor-blink: Whether to blink the cursor

--recent-files <UPath> ...: List of recently opened files

--warn-venv, --no-warn-venv: Warn when running in a virtual environment

--backup-on-save, --no-backup-on-save: Create backups before saving files

--kernel-name <str>, --kernel <str>: The name of the kernel to start by default

--record-cell-timing, --no-record-cell-timing: Should timing data be recorded in cell metadata.

--show-remote-inputs, --no-show-remote-inputs: Display inputs sent to the kernel by other clients

--show-remote-outputs, --no-show-remote-outputs: Display kernel outputs triggered by other clients

--wrap-cell-outputs, --no-wrap-cell-outputs: Wrap cell output text.

--text-output-limit <int>: Limit the amount of cell text output

--show-file-icons, --no-show-file-icons: Show file icons in the file manager

--show-hidden-files, --no-show-hidden-files: Show hidden files in the file manager

--line-numbers, --no-line-numbers: Show or hide line numbers

--relative-line-numbers, --no-relative-line-numbers: Use relative line numbers

--autoformat, --no-autoformat: Automatically re-format code cells when run

--autocomplete, --no-autocomplete: Provide completions suggestions automatically

--autosuggest {smart,simple,none}: Provide line completion suggestions

--show-status-bar, --no-show-status-bar: Show the status bar

--show-shadows, --no-show-shadows: Show or hide shadows under menus and dialogs

--tab-mode {stack,tile_horizontally,tile_vertically}: The method used to display multiple tabs

--always-show-tab-bar, --no-always-show-tab-bar: Always show the tab bar

--background-pattern {0,1,2,3,4,5}, --bg-pattern {0,1,2,3,4,5}: The background pattern to use

--background-character <str>, --bg-char <str>: Character for background pattern

--run-after-external-edit, --no-run-after-external-edit: Run cells after editing externally

--run, --no-run: Run the notebook files when loaded

--show-top-bar, --no-show-top-bar: Show the top bar

--show-side-bar, --no-show-side-bar: Show the side-bar

--side-bar-width <int>: Width of the side-bar

--side-bar-panel-index <<lambda>>: Active side-bar panel index

Available Commands

Command Available in Euporie Notebook