.. _cli-euporie-start:

Usage
=====

.. code-block:: console

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

.. option:: {console,edit,hub,notebook,preview}

   The application to launch

.. option:: <UPath> ...

   List of file names to open

Optional Arguments
==================

.. option:: -h, --help

   show this help message and exit

.. option:: --version, -V

   ==SUPPRESS==

.. option:: --log-file <str>

   File path for logs

.. option:: --log-level {debug,info,warning,error,critical}

   Set the log level

.. option:: --log-level-stdout {debug,info,warning,error,critical}

   ==SUPPRESS==

.. option:: --log-config <loads>

   Additional logging configuration

.. option:: --clipboard {external,internal,terminal}

   The preferred clipboard access method

.. option:: --edit-mode {micro,emacs,vi}

   Key-binding mode for text editing

.. option:: --tab-size <int>

   Spaces per indentation level

.. option:: --terminal-polling-interval <float>

   Time between terminal colour queries

.. option:: --formatters <loads>

   List of external code formatters

.. option:: --syntax-highlighting, --no-syntax-highlighting

   Syntax highlighting

.. option:: --syntax-theme <str>

   Syntax highlighting theme

.. option:: --color-depth {1,4,8,24}

   The color depth to use

.. option:: --multiplexer-passthrough, --no-multiplexer-passthrough

   ==SUPPRESS==

.. option:: --color-scheme {default,inverse,light,dark,black,white,custom}

   The color scheme to use

.. option:: --custom-background-color <str>, --custom-bg-color <str>, --bg <str>

   Background color for "Custom" color theme

.. option:: --custom-foreground-color <str>, --custom-fg-color <str>, --fg <str>

   Foreground color for "Custom" color theme

.. option:: --accent-color <str>

   Accent color to use in the app

.. option:: --custom-styles <loads>

   Additional style settings

.. option:: --key-bindings <loads>

   Additional key binding definitions

.. option:: --graphics {none,sixel,kitty,kitty-unicode,iterm}

   The preferred graphics protocol

.. option:: --force-graphics, --no-force-graphics

   Force use of specified graphics protocol

.. option:: --enable-language-servers, --lsp, --no-enable-language-servers, --no-lsp

   Enable language server support

.. option:: --language-servers <loads>

   Language server configurations

.. option:: --set-cursor-shape, --no-set-cursor-shape

   Whether to set the shape of the cursor depending on the editing mode

.. option:: --cursor-blink, --no-cursor-blink

   Whether to blink the cursor

.. option:: --recent-files <UPath> ...

   List of recently opened files

.. option:: --warn-venv, --no-warn-venv

   Warn when running in a virtual environment

.. option:: --line-numbers, --no-line-numbers

   Show or hide line numbers

.. option:: --relative-line-numbers, --no-relative-line-numbers

   Use relative line numbers

.. option:: --autoformat, --no-autoformat

   Automatically re-format code cells when run

.. option:: --autocomplete, --no-autocomplete

   Provide completions suggestions automatically

.. option:: --autosuggest {smart,simple,none}

   Provide line completion suggestions

.. option:: --show-status-bar, --no-show-status-bar

   Show the status bar

.. option:: --show-shadows, --no-show-shadows

   Show or hide shadows under menus and dialogs


.. _cli-euporie-end:
.. _cli-euporie-console-start:

Usage
=====

.. code-block:: console

   $ euporie-console [-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}]
                          [--autoinspect | --no-autoinspect]
                          [--show-status-bar | --no-show-status-bar]
                          [--show-shadows | --no-show-shadows]
                          [--mouse-support | --no-mouse-support]
                          [--max-stored-outputs int] [--connection-file UPath]
                          [UPath ...]

Positional Arguments
====================

.. option:: <UPath> ...

   List of file names to open

Optional Arguments
==================

.. option:: -h, --help

   show this help message and exit

.. option:: --version, -V

   ==SUPPRESS==

.. option:: --log-file <str>

   File path for logs

.. option:: --log-level {debug,info,warning,error,critical}

   Set the log level

.. option:: --log-level-stdout {debug,info,warning,error,critical}

   ==SUPPRESS==

.. option:: --log-config <loads>

   Additional logging configuration

.. option:: --clipboard {external,internal,terminal}

   The preferred clipboard access method

.. option:: --edit-mode {micro,emacs,vi}

   Key-binding mode for text editing

.. option:: --tab-size <int>

   Spaces per indentation level

.. option:: --terminal-polling-interval <float>

   Time between terminal colour queries

.. option:: --formatters <loads>

   List of external code formatters

.. option:: --syntax-highlighting, --no-syntax-highlighting

   Syntax highlighting

.. option:: --syntax-theme <str>

   Syntax highlighting theme

.. option:: --color-depth {1,4,8,24}

   The color depth to use

.. option:: --multiplexer-passthrough, --no-multiplexer-passthrough

   ==SUPPRESS==

.. option:: --color-scheme {default,inverse,light,dark,black,white,custom}

   The color scheme to use

.. option:: --custom-background-color <str>, --custom-bg-color <str>, --bg <str>

   Background color for "Custom" color theme

.. option:: --custom-foreground-color <str>, --custom-fg-color <str>, --fg <str>

   Foreground color for "Custom" color theme

.. option:: --accent-color <str>

   Accent color to use in the app

.. option:: --custom-styles <loads>

   Additional style settings

.. option:: --key-bindings <loads>

   Additional key binding definitions

.. option:: --graphics {none,sixel,kitty,kitty-unicode,iterm}

   The preferred graphics protocol

.. option:: --force-graphics, --no-force-graphics

   Force use of specified graphics protocol

.. option:: --enable-language-servers, --lsp, --no-enable-language-servers, --no-lsp

   Enable language server support

.. option:: --language-servers <loads>

   Language server configurations

.. option:: --set-cursor-shape, --no-set-cursor-shape

   Whether to set the shape of the cursor depending on the editing mode

.. option:: --cursor-blink, --no-cursor-blink

   Whether to blink the cursor

.. option:: --recent-files <UPath> ...

   List of recently opened files

.. option:: --warn-venv, --no-warn-venv

   Warn when running in a virtual environment

.. option:: --backup-on-save, --no-backup-on-save

   Create backups before saving files

.. option:: --kernel-name <str>, --kernel <str>

   The name of the kernel to start by default

.. option:: --record-cell-timing, --no-record-cell-timing

   Should timing data be recorded in cell metadata.

.. option:: --show-remote-inputs, --no-show-remote-inputs

   Display inputs sent to the kernel by other clients

.. option:: --show-remote-outputs, --no-show-remote-outputs

   Display kernel outputs triggered by other clients

.. option:: --wrap-cell-outputs, --no-wrap-cell-outputs

   Wrap cell output text.

.. option:: --text-output-limit <int>

   Limit the amount of cell text output

.. option:: --show-file-icons, --no-show-file-icons

   Show file icons in the file manager

.. option:: --show-hidden-files, --no-show-hidden-files

   Show hidden files in the file manager

.. option:: --line-numbers, --no-line-numbers

   Show or hide line numbers

.. option:: --relative-line-numbers, --no-relative-line-numbers

   Use relative line numbers

.. option:: --autoformat, --no-autoformat

   Automatically re-format code cells when run

.. option:: --autocomplete, --no-autocomplete

   Provide completions suggestions automatically

.. option:: --autosuggest {smart,simple,none}

   Provide line completion suggestions

.. option:: --autoinspect, --no-autoinspect

   Display contextual help automatically

.. option:: --show-status-bar, --no-show-status-bar

   Show the status bar

.. option:: --show-shadows, --no-show-shadows

   Show or hide shadows under menus and dialogs

.. option:: --mouse-support, --no-mouse-support

   Enable or disable mouse support

.. option:: --max-stored-outputs <int>

   The number of inputs / outputs to store in an in-memory notebook

.. option:: --connection-file <UPath>, --kernel-connection-file <UPath>

   Attempt to connect to an existing kernel using a JSON connection info file


.. _cli-euporie-console-end:
.. _cli-euporie-hub-start:

Usage
=====

.. code-block:: console

   $ euporie-hub [-h] [--host str] [--port int] [--host-keys [UPath ...]]
                      [--client-keys [UPath ...]] [--auth | --no-auth]
                      [--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,notebook,preview} [UPath ...]

Positional Arguments
====================

.. option:: {console,edit,notebook,preview}

   The application to launch

.. option:: <UPath> ...

   List of file names to open

Optional Arguments
==================

.. option:: -h, --help

   show this help message and exit

.. option:: --host <str>

   The host address to bind to

.. option:: --port <int>

   The port for the ssh server to use

.. option:: --host-keys <UPath> ...

   Host keys to use for the SSH server

.. option:: --client-keys <UPath> ...

   Client public keys authorized to connect

.. option:: --auth, --no-auth

   Allow unauthenticated access to euporie hub

.. option:: --version, -V

   ==SUPPRESS==

.. option:: --log-file <str>

   File path for logs

.. option:: --log-level {debug,info,warning,error,critical}

   Set the log level

.. option:: --log-level-stdout {debug,info,warning,error,critical}

   ==SUPPRESS==

.. option:: --log-config <loads>

   Additional logging configuration

.. option:: --clipboard {external,internal,terminal}

   The preferred clipboard access method

.. option:: --edit-mode {micro,emacs,vi}

   Key-binding mode for text editing

.. option:: --tab-size <int>

   Spaces per indentation level

.. option:: --terminal-polling-interval <float>

   Time between terminal colour queries

.. option:: --formatters <loads>

   List of external code formatters

.. option:: --syntax-highlighting, --no-syntax-highlighting

   Syntax highlighting

.. option:: --syntax-theme <str>

   Syntax highlighting theme

.. option:: --color-depth {1,4,8,24}

   The color depth to use

.. option:: --multiplexer-passthrough, --no-multiplexer-passthrough

   ==SUPPRESS==

.. option:: --color-scheme {default,inverse,light,dark,black,white,custom}

   The color scheme to use

.. option:: --custom-background-color <str>, --custom-bg-color <str>, --bg <str>

   Background color for "Custom" color theme

.. option:: --custom-foreground-color <str>, --custom-fg-color <str>, --fg <str>

   Foreground color for "Custom" color theme

.. option:: --accent-color <str>

   Accent color to use in the app

.. option:: --custom-styles <loads>

   Additional style settings

.. option:: --key-bindings <loads>

   Additional key binding definitions

.. option:: --graphics {none,sixel,kitty,kitty-unicode,iterm}

   The preferred graphics protocol

.. option:: --force-graphics, --no-force-graphics

   Force use of specified graphics protocol

.. option:: --enable-language-servers, --lsp, --no-enable-language-servers, --no-lsp

   Enable language server support

.. option:: --language-servers <loads>

   Language server configurations

.. option:: --set-cursor-shape, --no-set-cursor-shape

   Whether to set the shape of the cursor depending on the editing mode

.. option:: --cursor-blink, --no-cursor-blink

   Whether to blink the cursor

.. option:: --recent-files <UPath> ...

   List of recently opened files

.. option:: --warn-venv, --no-warn-venv

   Warn when running in a virtual environment

.. option:: --line-numbers, --no-line-numbers

   Show or hide line numbers

.. option:: --relative-line-numbers, --no-relative-line-numbers

   Use relative line numbers

.. option:: --autoformat, --no-autoformat

   Automatically re-format code cells when run

.. option:: --autocomplete, --no-autocomplete

   Provide completions suggestions automatically

.. option:: --autosuggest {smart,simple,none}

   Provide line completion suggestions

.. option:: --show-status-bar, --no-show-status-bar

   Show the status bar

.. option:: --show-shadows, --no-show-shadows

   Show or hide shadows under menus and dialogs


.. _cli-euporie-hub-end:
.. _cli-euporie-notebook-start:

Usage
=====

.. code-block:: console

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

.. option:: <UPath> ...

   List of file names to open

Optional Arguments
==================

.. option:: -h, --help

   show this help message and exit

.. option:: --version, -V

   ==SUPPRESS==

.. option:: --log-file <str>

   File path for logs

.. option:: --log-level {debug,info,warning,error,critical}

   Set the log level

.. option:: --log-level-stdout {debug,info,warning,error,critical}

   ==SUPPRESS==

.. option:: --log-config <loads>

   Additional logging configuration

.. option:: --clipboard {external,internal,terminal}

   The preferred clipboard access method

.. option:: --edit-mode {micro,emacs,vi}

   Key-binding mode for text editing

.. option:: --tab-size <int>

   Spaces per indentation level

.. option:: --terminal-polling-interval <float>

   Time between terminal colour queries

.. option:: --formatters <loads>

   List of external code formatters

.. option:: --syntax-highlighting, --no-syntax-highlighting

   Syntax highlighting

.. option:: --syntax-theme <str>

   Syntax highlighting theme

.. option:: --color-depth {1,4,8,24}

   The color depth to use

.. option:: --multiplexer-passthrough, --no-multiplexer-passthrough

   ==SUPPRESS==

.. option:: --color-scheme {default,inverse,light,dark,black,white,custom}

   The color scheme to use

.. option:: --custom-background-color <str>, --custom-bg-color <str>, --bg <str>

   Background color for "Custom" color theme

.. option:: --custom-foreground-color <str>, --custom-fg-color <str>, --fg <str>

   Foreground color for "Custom" color theme

.. option:: --accent-color <str>

   Accent color to use in the app

.. option:: --custom-styles <loads>

   Additional style settings

.. option:: --key-bindings <loads>

   Additional key binding definitions

.. option:: --graphics {none,sixel,kitty,kitty-unicode,iterm}

   The preferred graphics protocol

.. option:: --force-graphics, --no-force-graphics

   Force use of specified graphics protocol

.. option:: --enable-language-servers, --lsp, --no-enable-language-servers, --no-lsp

   Enable language server support

.. option:: --language-servers <loads>

   Language server configurations

.. option:: --set-cursor-shape, --no-set-cursor-shape

   Whether to set the shape of the cursor depending on the editing mode

.. option:: --cursor-blink, --no-cursor-blink

   Whether to blink the cursor

.. option:: --recent-files <UPath> ...

   List of recently opened files

.. option:: --warn-venv, --no-warn-venv

   Warn when running in a virtual environment

.. option:: --backup-on-save, --no-backup-on-save

   Create backups before saving files

.. option:: --kernel-name <str>, --kernel <str>

   The name of the kernel to start by default

.. option:: --record-cell-timing, --no-record-cell-timing

   Should timing data be recorded in cell metadata.

.. option:: --show-remote-inputs, --no-show-remote-inputs

   Display inputs sent to the kernel by other clients

.. option:: --show-remote-outputs, --no-show-remote-outputs

   Display kernel outputs triggered by other clients

.. option:: --wrap-cell-outputs, --no-wrap-cell-outputs

   Wrap cell output text.

.. option:: --text-output-limit <int>

   Limit the amount of cell text output

.. option:: --show-file-icons, --no-show-file-icons

   Show file icons in the file manager

.. option:: --show-hidden-files, --no-show-hidden-files

   Show hidden files in the file manager

.. option:: --line-numbers, --no-line-numbers

   Show or hide line numbers

.. option:: --relative-line-numbers, --no-relative-line-numbers

   Use relative line numbers

.. option:: --autoformat, --no-autoformat

   Automatically re-format code cells when run

.. option:: --autocomplete, --no-autocomplete

   Provide completions suggestions automatically

.. option:: --autosuggest {smart,simple,none}

   Provide line completion suggestions

.. option:: --show-status-bar, --no-show-status-bar

   Show the status bar

.. option:: --show-shadows, --no-show-shadows

   Show or hide shadows under menus and dialogs

.. option:: --tab-mode {stack,tile_horizontally,tile_vertically}

   The method used to display multiple tabs

.. option:: --always-show-tab-bar, --no-always-show-tab-bar

   Always show the tab bar

.. option:: --background-pattern {0,1,2,3,4,5}, --bg-pattern {0,1,2,3,4,5}

   The background pattern to use

.. option:: --background-character <str>, --bg-char <str>

   Character for background pattern

.. option:: --run-after-external-edit, --no-run-after-external-edit

   Run cells after editing externally

.. option:: --run, --no-run

   Run the notebook files when loaded

.. option:: --show-top-bar, --no-show-top-bar

   Show the top bar

.. option:: --show-side-bar, --no-show-side-bar

   Show the side-bar

.. option:: --side-bar-width <int>

   Width of the side-bar

.. option:: --side-bar-panel-index <<lambda>>

   Active side-bar panel index


.. _cli-euporie-notebook-end:
.. _cli-euporie-preview-start:

Usage
=====

.. code-block:: console

   $ euporie-preview [-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]
                          [--save-widget-state | --no-save-widget-state]
                          [--max-notebook-width int] [--expand | --no-expand]
                          [--wrap-cell-outputs | --no-wrap-cell-outputs]
                          [--text-output-limit int]
                          [--line-numbers | --no-line-numbers]
                          [--relative-line-numbers | --no-relative-line-numbers]
                          [--autoformat | --no-autoformat]
                          [--autocomplete | --no-autocomplete]
                          [--autosuggest {smart,simple,none}]
                          [--autoinspect | --no-autoinspect]
                          [--show-status-bar | --no-show-status-bar]
                          [--show-shadows | --no-show-shadows]
                          [--show-cell-borders | --no-show-cell-borders]
                          [--external-editor str] [--output-file [UPath]]
                          [--page | --no-page] [--run | --no-run]
                          [--save | --no-save]
                          [--show-filenames | --no-show-filenames]
                          [--cell-start int] [--cell-stop int]
                          [UPath ...]

Positional Arguments
====================

.. option:: <UPath> ...

   List of file names to open

Optional Arguments
==================

.. option:: -h, --help

   show this help message and exit

.. option:: --version, -V

   ==SUPPRESS==

.. option:: --log-file <str>

   File path for logs

.. option:: --log-level {debug,info,warning,error,critical}

   Set the log level

.. option:: --log-level-stdout {debug,info,warning,error,critical}

   ==SUPPRESS==

.. option:: --log-config <loads>

   Additional logging configuration

.. option:: --clipboard {external,internal,terminal}

   The preferred clipboard access method

.. option:: --edit-mode {micro,emacs,vi}

   Key-binding mode for text editing

.. option:: --tab-size <int>

   Spaces per indentation level

.. option:: --terminal-polling-interval <float>

   Time between terminal colour queries

.. option:: --formatters <loads>

   List of external code formatters

.. option:: --syntax-highlighting, --no-syntax-highlighting

   Syntax highlighting

.. option:: --syntax-theme <str>

   Syntax highlighting theme

.. option:: --color-depth {1,4,8,24}

   The color depth to use

.. option:: --multiplexer-passthrough, --no-multiplexer-passthrough

   ==SUPPRESS==

.. option:: --color-scheme {default,inverse,light,dark,black,white,custom}

   The color scheme to use

.. option:: --custom-background-color <str>, --custom-bg-color <str>, --bg <str>

   Background color for "Custom" color theme

.. option:: --custom-foreground-color <str>, --custom-fg-color <str>, --fg <str>

   Foreground color for "Custom" color theme

.. option:: --accent-color <str>

   Accent color to use in the app

.. option:: --custom-styles <loads>

   Additional style settings

.. option:: --key-bindings <loads>

   Additional key binding definitions

.. option:: --graphics {none,sixel,kitty,kitty-unicode,iterm}

   The preferred graphics protocol

.. option:: --force-graphics, --no-force-graphics

   Force use of specified graphics protocol

.. option:: --enable-language-servers, --lsp, --no-enable-language-servers, --no-lsp

   Enable language server support

.. option:: --language-servers <loads>

   Language server configurations

.. option:: --set-cursor-shape, --no-set-cursor-shape

   Whether to set the shape of the cursor depending on the editing mode

.. option:: --cursor-blink, --no-cursor-blink

   Whether to blink the cursor

.. option:: --recent-files <UPath> ...

   List of recently opened files

.. option:: --warn-venv, --no-warn-venv

   Warn when running in a virtual environment

.. option:: --backup-on-save, --no-backup-on-save

   Create backups before saving files

.. option:: --kernel-name <str>, --kernel <str>

   The name of the kernel to start by default

.. option:: --record-cell-timing, --no-record-cell-timing

   Should timing data be recorded in cell metadata.

.. option:: --show-remote-inputs, --no-show-remote-inputs

   Display inputs sent to the kernel by other clients

.. option:: --show-remote-outputs, --no-show-remote-outputs

   Display kernel outputs triggered by other clients

.. option:: --save-widget-state, --no-save-widget-state

   Save a notebook's widget state in the notebook metadata

.. option:: --max-notebook-width <int>

   Maximum width of notebooks

.. option:: --expand, --no-expand

   Use the full width to display notebooks

.. option:: --wrap-cell-outputs, --no-wrap-cell-outputs

   Wrap cell output text.

.. option:: --text-output-limit <int>

   Limit the amount of cell text output

.. option:: --line-numbers, --no-line-numbers

   Show or hide line numbers

.. option:: --relative-line-numbers, --no-relative-line-numbers

   Use relative line numbers

.. option:: --autoformat, --no-autoformat

   Automatically re-format code cells when run

.. option:: --autocomplete, --no-autocomplete

   Provide completions suggestions automatically

.. option:: --autosuggest {smart,simple,none}

   Provide line completion suggestions

.. option:: --autoinspect, --no-autoinspect

   Display contextual help automatically

.. option:: --show-status-bar, --no-show-status-bar

   Show the status bar

.. option:: --show-shadows, --no-show-shadows

   Show or hide shadows under menus and dialogs

.. option:: --show-cell-borders, --no-show-cell-borders

   Show or hide cell borders.

.. option:: --external-editor <str>

   Set the external editor to use.

.. option:: --output-file <UPath>

   Output path when previewing file

.. option:: --page, --no-page

   Pass output to pager

.. option:: --run, --no-run

   Run the notebook files when loaded

.. option:: --save, --no-save

   Save the notebook after running it

.. option:: --show-filenames, --no-show-filenames

   Show the notebook filenames when previewing multiple notebooks

.. option:: --cell-start <int>

   The first cell to include in the preview

.. option:: --cell-stop <int>

   The last cell to include in the preview


.. _cli-euporie-preview-end: