- version
- flags:
- default:
False
- type:
- description:
Show the version number and exit
If set, euporie will print the current version number of the application and exit. All other configuration options will be ignored.
Note
This cannot be set in the configuration file or via an environment variable
- clipboard
- flags:
- environment variable:
EUPORIE_CLIPBOARD
- default:
'external'
- type:
string
- options:
[
'external'
,'internal'
,'terminal'
]- description:
The preferred clipboard access method
The clipboard access method to use. -
external
: Data is saved to the system clipboard using OS native tooling. -internal
: Clipboard data is only stored and usable inside euporie - it isnot saved to the system clipboard.
terminal
: uses OSC52 escape sequences to retrieve and set the clipboardcontents. Requires your terminal emulator to support OSC52. Works over SSH.
- log_file
- flags:
- environment variable:
EUPORIE_LOG_FILE
- default:
''
- type:
string
- description:
File path for logs
When set to a file path, the log output will be written to the given path. If no value is given output will be sent to the standard output.
- log_level
- flags:
- environment variable:
EUPORIE_LOG_LEVEL
- default:
'warning'
- type:
string
- options:
[
'debug'
,'info'
,'warning'
,'error'
,'critical'
]- description:
Set the log level
When set, logging events at the given level are emitted.
- log_config
- flags:
- environment variable:
EUPORIE_LOG_CONFIG
- type:
string
- description:
Additional logging configuration
A JSON string specifying additional logging configuration.
- show_shadows
- flags:
- environment variable:
EUPORIE_SHOW_SHADOWS
- default:
True
- type:
- description:
Show or hide shadows under menus and dialogs
Sets whether shadows are shown under dialogs and popup-menus.
- show_status_bar
- flags:
- environment variable:
EUPORIE_SHOW_STATUS_BAR
- default:
True
- type:
- description:
Show the status bar
Whether the status bar should be shown at the bottom of the screen.
- set_cursor_shape
- flags:
- environment variable:
EUPORIE_SET_CURSOR_SHAPE
- default:
True
- type:
- description:
Whether to set the shape of the cursor depending on the editing mode
When set to True, the euporie will set the shape of the terminal’s cursor to a beam in insert mode and and underline in replace mode when editing.
- cursor_blink
- flags:
- environment variable:
EUPORIE_CURSOR_BLINK
- default:
False
- type:
- description:
Whether to blink the cursor
When set to True, the cursor will blink.
- files
- environment variable:
EUPORIE_FILES
- default:
[]
- type:
array
- description:
List of file names to open
A list of file paths to open when euporie is launched.
- edit_mode
- flags:
- environment variable:
EUPORIE_EDIT_MODE
- default:
'micro'
- type:
string
- options:
[
'micro'
,'emacs'
,'vi'
]- description:
Key-binding mode for text editing
Key binding style to use when editing cells.
- tab_size
- flags:
- environment variable:
EUPORIE_TAB_SIZE
- default:
4
- type:
- description:
Spaces per indentation level
The number of spaces to use per indentation level. Should be set to 4.
- terminal_polling_interval
- flags:
- environment variable:
EUPORIE_TERMINAL_POLLING_INTERVAL
- default:
0.0
- type:
- description:
Time between terminal colour queries
Determine how frequently the terminal should be polled for changes to the background / foreground colours. Set to zero to disable terminal polling.
- formatters
- flags:
- environment variable:
EUPORIE_FORMATTERS
- default:
[]
- type:
array
- description:
List of external code formatters
An array listing languages and commands of formatters to use for reformatting code cells. The command is an array of the command any any arguments. Code to be formatted is pass in via the standard input, and replaced with the standard output.
e.g.
- [
{“command”: [“ruff”, “format”, “-“], “languages”: [“python”]}, {“command”: [“black”, “-“], “languages”: [“python”]}, {“command”: [“isort”, “-“], “languages”: [“python”]}
]
- syntax_theme
- flags:
- environment variable:
EUPORIE_SYNTAX_THEME
- default:
'euporie'
- type:
string
- description:
Syntax highlighting theme
The name of the pygments style to use for syntax highlighting.
- color_depth
- flags:
- environment variable:
EUPORIE_COLOR_DEPTH
- type:
- options:
[
1
,4
,8
,24
]- description:
The color depth to use
The number of bits to use to represent colors displayable on the screen. If set to None, the supported color depth of the terminal will be detected automatically.
- multiplexer_passthrough
- flags:
- environment variable:
EUPORIE_MULTIPLEXER_PASSTHROUGH
- default:
False
- type:
- description:
Use passthrough from within terminal multiplexers
If set and euporie is running inside a terminal multiplexer (screen or tmux), then certain escape sequences will be passed-through the multiplexer directly to the terminal.
This affects things such as terminal color detection and graphics display.
for tmux, you will also need to ensure that
allow-passthrough
is set toon
in your tmux configuration.Warning
Terminal graphics in tmux is experimental, and is not guaranteed to work. Use at your own risk!
Note
As of version tmux version
3.4
sixel graphics are supported, which may result in better terminal graphics then using multiplexer passthrough.
- color_scheme
- flags:
- environment variable:
EUPORIE_COLOR_SCHEME
- default:
'default'
- type:
string
- options:
[
'default'
,'inverse'
,'light'
,'dark'
,'black'
,'white'
,'custom'
]- description:
The color scheme to use
The color scheme to use: auto means euporie will try to use your terminal’s color scheme, light means black text on a white background, and dark means white text on a black background.
- custom_background_color
- flags:
- environment variable:
EUPORIE_CUSTOM_BACKGROUND_COLOR
- default:
'#073642'
- type:
string
- description:
Background color for “Custom” color theme
The hex code of the color to use for the background in the “Custom” color scheme.
- custom_foreground_color
- flags:
- environment variable:
EUPORIE_CUSTOM_FOREGROUND_COLOR
- default:
'#839496'
- type:
string
- description:
Foreground color for “Custom” color theme
The hex code of the color to use for the foreground in the “Custom” color scheme.
- accent_color
- flags:
- environment variable:
EUPORIE_ACCENT_COLOR
- default:
'ansiblue'
- type:
string
- description:
Accent color to use in the app
The hex code of a color to use for the accent color in the application.
- key_bindings
- flags:
- environment variable:
EUPORIE_KEY_BINDINGS
- default:
{}
- type:
- description:
Additional key binding definitions
A mapping of component names to mappings of command name to key-binding lists.
- graphics
- flags:
- environment variable:
EUPORIE_GRAPHICS
- type:
string
- options:
[
'none'
,'sixel'
,'kitty'
,'iterm'
]- description:
The preferred graphics protocol
The graphics protocol to use, if supported by the terminal. If set to “none”, terminal graphics will not be used.
- force_graphics
- flags:
- environment variable:
EUPORIE_FORCE_GRAPHICS
- default:
False
- type:
- description:
Force use of specified graphics protocol
When set to
True
, the graphics protocol specified by thegraphics
configuration option will be used even if the terminal does not support it.This is also useful if you want to use graphics in euporie-hub.
- enable_language_servers
- flags:
- environment variable:
EUPORIE_ENABLE_LANGUAGE_SERVERS
- default:
False
- type:
- description:
Enable language server support
When set to
True
, language servers will be used for liniting, code inspection, and code formatting.Additional language servers can be added using the
language-servers
option.
- language_servers
- flags:
- environment variable:
EUPORIE_LANGUAGE_SERVERS
- default:
{}
- type:
- description:
Language server configurations
Additional language servers can be defined here, e.g.:
- {
“ruff”: {“command”: [“ruff-lsp”], “languages”: [“python”]}, “pylsp”: {“command”: [“pylsp”], “languages”: [“python”]}, “typos”: {“command”: [“typos-lsp”], “languages”: []}
}
The following properties are required: - The name to be given to the the language server, must be unique - The command list consists of the process to launch, followed by any
command line arguments
A list of language the language server supports. If no languages are
given, the language server will be used for documents of any language.
To disable one of the default language servers, its name can be set to an empty dictionary. For example, the following would disable the awk language server:
- {
“awk-language-server”: {},
}
- wrap_cell_outputs
- flags:
- environment variable:
EUPORIE_WRAP_CELL_OUTPUTS
- default:
False
- type:
- description:
Wrap cell output text.
Whether text-based cell outputs should be wrapped.
- line_numbers
- flags:
- environment variable:
EUPORIE_LINE_NUMBERS
- default:
True
- type:
- description:
Show or hide line numbers
Whether line numbers are shown by default.
- autoformat
- flags:
- environment variable:
EUPORIE_AUTOFORMAT
- default:
False
- type:
- description:
Automatically re-format code cells when run
Whether to automatically reformat code cells before they are run.
- autocomplete
- flags:
- environment variable:
EUPORIE_AUTOCOMPLETE
- default:
False
- type:
- description:
Provide completions suggestions automatically
Whether to automatically suggestion completions while typing in code cells.
- autosuggest
- flags:
- environment variable:
EUPORIE_AUTOSUGGEST
- default:
True
- type:
- description:
Provide line completion suggestions
Whether to automatically suggestion line content while typing in code cells.
- autoinspect
- flags:
- environment variable:
EUPORIE_AUTOINSPECT
- default:
False
- type:
- description:
Display contextual help automatically
Whether to automatically display contextual help when navigating through code cells.
- kernel_name
- flags:
- environment variable:
EUPORIE_KERNEL_NAME
- default:
'python3'
- type:
string
- description:
The name of the kernel to start by default
The name of the kernel selected automatically by the console app or in new notebooks. If set to an empty string, the user will be asked which kernel to launch.
- record_cell_timing
- flags:
- environment variable:
EUPORIE_RECORD_CELL_TIMING
- default:
False
- type:
- description:
Should timing data be recorded in cell metadata.
When set, execution timing data will be recorded in cell metadata.
- max_stored_outputs
- flags:
- environment variable:
EUPORIE_MAX_STORED_OUTPUTS
- default:
100
- type:
- description:
The number of inputs / outputs to store in an in-memory notebook
Defines the maximum number of executed “cells” to store in case the console session is saved to a file or converted into a notebook.
- connection_file
- flags:
- environment variable:
EUPORIE_CONNECTION_FILE
- type:
string
- description:
Attempt to connect to an existing kernel using a JSON connection info file
If the file does not exist, kernel connection information will be written to the file path provided.
If the file exists, kernel connection info will be read from the file, allowing euporie to connect to existing kernels.
- show_file_icons
- flags:
- environment variable:
EUPORIE_SHOW_FILE_ICONS
- default:
False
- type:
- description:
Show file icons in the file manager
Whether file icons should be shown in the file manager.
These icons exist in the unicode private use area, and may require custom fonts such as
awesome-terminal-fonts
ornerdfonts
to be installed.
- mouse_support
- flags:
- environment variable:
EUPORIE_MOUSE_SUPPORT
- type:
- description:
Enable or disable mouse support
When set to True, mouse support is enabled. When set to False, mouse support is disabled.
- app
- environment variable:
EUPORIE_APP
- default:
'notebook'
- type:
string
- options:
[
'console'
,'edit'
,'hub'
,'notebook'
,'preview'
]- description:
The application to launch
The name of the application to launch.
- host
- flags:
- environment variable:
EUPORIE_HOST
- default:
''
- type:
string
- description:
The host address to bind to
This determines the host address the euporie hub SSH server will bind to.
- port
- flags:
- environment variable:
EUPORIE_PORT
- default:
8022
- type:
- description:
The port for the ssh server to use
This determines which port euporie will listen on for connections to euporie hub.
- host_keys
- flags:
- environment variable:
EUPORIE_HOST_KEYS
- default:
['/etc/ssh/ssh_host_ecdsa_key']
- type:
array
- description:
Host keys to use for the SSH server
One or more SSH host key files to use for the euporie hub SSH server.
- client_keys
- flags:
- environment variable:
EUPORIE_CLIENT_KEYS
- default:
['~/.ssh/authorized_keys']
- type:
array
- description:
Client public keys authorized to connect
One or more OpenSSH-style
authorized_keys
files, containing public keys for authorized clients.
- auth
- flags:
- environment variable:
EUPORIE_AUTH
- default:
True
- type:
- description:
Allow unauthenticated access to euporie hub
When set, users will be able to access euporie hub without authentication.
Warning
This option is dangerous, as arbitrary code can be executed through euporie apps.
- show_cell_borders
- flags:
- environment variable:
EUPORIE_SHOW_CELL_BORDERS
- default:
False
- type:
- description:
Show or hide cell borders.
Whether cell borders should be drawn for unselected cells.
- external_editor
- flags:
- environment variable:
EUPORIE_EXTERNAL_EDITOR
- type:
string
- description:
Set the external editor to use.
A command to run when editing cells externally. The following strings in the command will be replaced with values which locate the cell being edited:
{top}
{left}
{bottom}
{right}
{width}
{height}
This is useful if you run euporie inside a tmux session, and wish to launch your editor in a pop-up pane. This can be achieved by setting this parameter to something like the following:
"tmux display-popup -x {left} -y {bottom} -w {width} -h {height} -B -E micro"
- save_widget_state
- flags:
- environment variable:
EUPORIE_SAVE_WIDGET_STATE
- default:
True
- type:
- description:
Save a notebook’s widget state in the notebook metadata
When set to
True
, the state of any widgets in the current notebook will be saves in the notebook’s metadata. This enables widgets to be displayed when the notebook is re-opened without having to re-run the notebook.
- max_notebook_width
- flags:
- environment variable:
EUPORIE_MAX_NOTEBOOK_WIDTH
- default:
120
- type:
- description:
Maximum width of notebooks
The maximum width at which to display a notebook.
- expand
- flags:
- environment variable:
EUPORIE_EXPAND
- default:
False
- type:
- description:
Use the full width to display notebooks
Whether the notebook page should expand to fill the available width
- show_scroll_bar
- flags:
- environment variable:
EUPORIE_SHOW_SCROLL_BAR
- default:
True
- type:
- description:
Show the scroll bar
Whether the scroll bar should be shown on the right of the screen.
- show_side_bar
- flags:
- environment variable:
EUPORIE_SHOW_SIDE_BAR
- default:
False
- type:
- description:
Show the side-bar
Whether the side-bar should be shown at the side of the screen.
- tab_mode
- flags:
- environment variable:
EUPORIE_TAB_MODE
- default:
'stack'
- type:
string
- options:
[
'stack'
,'tile_horizontally'
,'tile_vertically'
]- description:
The method used to display multiple tabs
Determines how multiple tabs are displayed when more than one tab is open. *
stack
displays one tab at a time with a tab-bar *tile_horizontally
displays tabs side-by-side *tile_vertically
displays tabs one-atop-the-next
- always_show_tab_bar
- flags:
- environment variable:
EUPORIE_ALWAYS_SHOW_TAB_BAR
- default:
False
- type:
- description:
Always show the tab bar
When set, the tab bar will always be shown - otherwise the tab bar is only shown when multiple tabs are open.
- background_pattern
- flags:
- environment variable:
EUPORIE_BACKGROUND_PATTERN
- default:
2
- type:
- options:
[
0
,1
,2
,3
,4
,5
]- description:
The background pattern to use
The background pattern to use when the notebook is narrower than the available width. Zero mean no pattern is used.
- background_character
- flags:
- environment variable:
EUPORIE_BACKGROUND_CHARACTER
- default:
'·'
- type:
string
- description:
Character for background pattern
The character to use when drawing the background pattern.
Recommended characters include: “·”, “⬤”, “╳”, “╱”, “╲”, “░”, “▒”, “▓”, “▞”, “╬”
- run_after_external_edit
- flags:
- environment variable:
EUPORIE_RUN_AFTER_EXTERNAL_EDIT
- default:
False
- type:
- description:
Run cells after editing externally
Whether to execute a cell immediately after editing in $EDITOR.
- run
- flags:
- environment variable:
EUPORIE_RUN
- default:
False
- type:
- description:
Run the notebook files when loaded
If set, notebooks will be run automatically when opened, or if previewing a file, the notebooks will be run before being output.
- show_top_bar
- flags:
- environment variable:
EUPORIE_SHOW_TOP_BAR
- default:
True
- type:
- description:
Show the top bar
Whether the top bar should be shown at the top of the screen.
- save
- flags:
- environment variable:
EUPORIE_SAVE
- default:
False
- type:
- description:
Save the notebook after running it
If set, notebooks will be saved after they have been run. This setting only has any affect if the
run
setting is active.
- show_filenames
- flags:
- environment variable:
EUPORIE_SHOW_FILENAMES
- default:
False
- type:
- description:
Show the notebook filenames when previewing multiple notebooks
If set, the notebook filenames will be printed above each notebook’s output when multiple notebooks are being previewed.
- cell_start
- flags:
- environment variable:
EUPORIE_CELL_START
- type:
- description:
The first cell to include in the preview
When set, only cells after the given cell index will be shown.
- cell_stop
- flags:
- environment variable:
EUPORIE_CELL_STOP
- type:
- description:
The last cell to include in the preview
When set, only cells before the given cell index will be shown.
- output_file
- flags:
- environment variable:
EUPORIE_OUTPUT_FILE
- default:
'-'
- type:
string
- description:
Output path when previewing file
When set to a file path, the formatted output will be written to the given path. If no value is given (or the default “-” is passed) output will be printed to standard output.
- page