Editor features#

This guide introduces some of marimo editor’s features, including a variables panel, dependency graph viewer, table of contents, HTML export, GitHub copilot, code formatting, HTML export, a feedback form, and more.

This guide introduces some of these features.

Settings#

The editor exposes of a number of settings for the current notebook, as well as user-wide configuration that will apply to all your notebooks. These settings include the option to display the current notebook in full width, to use vim keybindings, to enable GitHub copilot, and more.

To access these settings, click the gear icon in the top-right of the editor.

Click the gear icon to access notebook and editor settings.

Overview panels#

marimo ships with the following IDE-like panels that help provide an overview of your notebook:

  1. errors: view errors in each cell;

  2. variables: explore variable values, see where they are defined and used;

  3. dependency graph: view dependencies between cells;

  4. table of contents: corresponding to your markdown;

  5. logs: a continuous stream of stdout and stderr.

Click these buttons to access the editor panels.

These panels can be toggled via the buttons in the lower left of the editor.

Cell actions#

Click the dot array to the right of a cell to pull up a context menu (or hold and drag to move the cell):

Access cell actions like code formatting, hiding code, and more through the cell context menu.

Keyboard shortcuts#

We’ve kept some well-known keyboard shortcuts for notebooks (Ctrl-Enter, Shift-Enter), dropped others, and added a few of our own. Hit Ctrl/Cmd-Shift-H to pull up the shortcuts.

We know keyboard shortcuts are very personal; we’ll let you remap them in the future.

Missing a shortcut? File a GitHub issue.

Command palette#

Hit Cmd/Ctrl+K to open the command palette.

Quickly access common commands with the command palette.

Missing a command? File a GitHub issue.

Module autoreloading#

Enable module autoreloading via the settings icon (top right). When enabled, when Python modules that your notebook imports are modified, marimo reloads those modifications so you can use the latest version of your code. This works recursively, meaning that marimo tracks modifications for modules imported by your notebook’s imported modules too.

Autoreloading comes in two types:

  • “detect”: automatically marks cells affected by module modifications as stale, letting you know which cells need to be re-run.

  • “autorun”: automatically re-runs cells affected by module modification.

Note: Make sure the imported modules are in packages/folders with __init__.py files, otherwise marimo’s detection may fail.

Why autoreload? Autoreloading enables a workflow that many developers find productive: develop complex logic in Python modules, and use the marimo notebook as a DAG or main script that orchestrates your logic.

Export to static HTML#

Export the current view your notebook to static HTML via the notebook menu:

Download as static HTML.

You can also export to HTML at the command-line:

marimo export html notebook.py -o notebook.html

Configuration#

Click the settings icon in the top right to access important configuration settings. For example, you can configure marimo to not autorun on startup. You can also enable GitHub Copilot from this menu.

Configure settings.

A non-exhausted list of settings:

  • Vim keymaps

  • Dark mode

  • Auto-save

  • Auto-complete

  • Editor font-size

  • Formatting rules

  • GitHub Copilot

  • Autoreloading/Hot-reloading

Send feedback#

The question mark icon in the panels tray (lower left of the editor) opens a dialog to send anonymous feedback. We welcome any and all feedback, from the tiniest quibbles to the biggest blue sky dreams.

Send anonymous feedback with our feedback form.

If you’d like your feedback to start a conversation (we’d love to talk with you!), please consider posting in our GitHub issues or Discord. But if you’re in a flow state and can’t context switch out, the feedback form has your back.