Overview

Euporie consists of four applications, each providing different functionality:

Euporie Notebook: This is an interactive TUI Jupyter Notebook editor, which runs in the terminal and allows you to view, edit and run Jupyter Notebooks. It makes full use of Jupyter’s rich output system, and is able to render a range of media in the terminal.
Euporie Console: This is a terminal frontend for kernels using the Jupyter protocol, which makes use of euporie’s rich display system for kernel output. It is capable for displaying interactive widgets using ipywidgets. You can convert the history of a console session to a notebook.
Euporie Preview: This allows you to preview notebooks in the terminal without opening them in the editor. The rendered notebook output can be printed to the standard output, piped to a pager, or saved to a file. You can also run notebooks before rendering them.
Euporie Hub: This allows you to run euporie as a multi-user SSH server, meaning that multiple users can share a server’s resources. Each connected user is presented with the euporie editor interface, and can use it to open, run and edit notebooks.

Command Line Interface

In addition to being launched directly, each application in eurporie can be launched by passing its name as an argument to the euporie command.

Usage

$ euporie [-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]
               [--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]
               {console,edit,hub,notebook,preview} [UPath ...]

Positional Arguments

{console,edit,hub,notebook,preview}: The application to launch

<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

--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