Editor overview

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, a feedback form, and more.

Configuration

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.

Configure settings.

A non-exhaustive list of settings:

Vim keybindings

marimo supports vim keybindings.

Additional bindings/features:

  • gd - go to definition

  • dd - when a cell is empty, delete it

Click the gear icon to access notebook and editor settings.

Overview panels

marimo ships with the IDE panels that provide an overview of your notebook:

  1. file explorer: view the file tree, open other notebooks

  2. variables: explore variable values, see where they are defined and used, with go-to-definition

  3. data explorer: see dataframe and table schemas at a glance

  4. dependency graph: view dependencies between cells, drill-down on nodes and edges

  5. table of contents: corresponding to your markdown

  6. documentation - move your text cursor over a symbol to see its documentation

  7. logs: a continuous stream of stdout and stderr

  8. scratchpad: a scratchpad cell where you can execute throwaway code

  9. snippets - searchable snippets to copy directly into your notebook

  10. feedback - share feedback!

These panels can be toggled via the buttons in the 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.

Right-click menus

marimo supports context-sensitive right-click menus in various locations of the editor. Right-click on a cell to open a context-sensitive menu; right click on the create-cell button (the plus icon) to get options for the cell type to create.

Go-to-definition

  • Click on a variable in the editor to see where it’s defined and used

  • Cmd/Ctrl-Click on a variable to jump to its definition

  • Right-click on a variable to see a context menu with options to jump to its definition

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; you can remap them in the configuration.

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.

Share on our online playground

Get a link to share your notebook via our online playground:

Our online playground uses WebAssembly. Most but not all packages on PyPI are supported. Local files are not synchronized to our playground.

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

Send feedback

The question mark icon in the panel tray 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.