Skip to content

Quickstart

Installing marimo gets you the marimo command-line interface (CLI), the entry point to all things marimo.

Run tutorials

marimo tutorial intro opens the intro tutorial. List all tutorials with

marimo tutorial --help

See marimo in action on YouTube

The marimo concepts playlist on our YouTube channel gives an overview of many features.

Edit notebooks

Create and edit notebooks with marimo edit.

  • launch the notebook server to create new notebooks, and start or stop existing ones:
marimo edit
  • create or edit a single notebook with
marimo edit your_notebook.py

(If your_notebook.py doesn't exist, marimo will create a blank notebook named your_notebook.py.)

Deploy as apps

Use marimo run to serve your notebook as an app, with Python code hidden and uneditable.

marimo run your_notebook.py

Run as scripts

Run your notebook as a script with

python your_notebook.py

You can also pass CLI args to your notebook.

Convert Jupyter notebooks and Python scripts to marimo

Automatically convert Jupyter notebooks and Python scripts to marimo notebooks with marimo convert:

# From Jupyter notebook
marimo convert your_notebook.ipynb -o your_notebook.py

# From Python script or jupytext py:percent format
marimo convert your_script.py -o your_notebook.py

Then open the notebook with marimo edit your_notebook.py

Disable autorun on startup

marimo automatically runs notebooks when they are opened. If this is a problem for you (not all Jupyter notebooks are designed to be run on startup), you can disable autorun on startup via user configuration.

  1. Type marimo config show to get the location of your config file.
  2. If no config file exists, create it at $XDG_CONFIG_HOME/marimo/marimo.toml.
  3. Update your config to include the following:
marimo.toml
[runtime]
auto_instantiate = false

Export marimo notebooks to other file formats

Use

marimo export

to export marimo notebooks to other file formats, including HTML, IPYNB, and markdown.

Install optional dependencies for more features

Some features require additional dependencies, which are not installed by default. This includes:

To install the optional dependencies, run:

pip install "marimo[recommended]"

uv add "marimo[recommended]"

conda install -c conda-forge marimo duckdb altair polars openai ruff

This will install: duckdb, altair, polars, openai, and ruff.

Enable GitHub Copilot and AI Assistant

The marimo editor natively supports GitHub Copilot, an AI pair programmer, similar to VS Code.

Get started with Copilot:

  1. Install Node.js.
  2. Enable Copilot via the settings menu in the marimo editor.

Note: Copilot is not yet available in our conda distribution; please install marimo from PyPI if you need Copilot.

marimo also comes with support for other copilots, and a built-in AI assistant that helps you write code.

Use molab, a cloud-based marimo notebook service similar to Google Colab, to create and share notebook links (docs).

Coming from VS Code?

The best way to use marimo is through the CLI. While we do have a VS Code extension, we are actively rewriting it to provide a more native and robust experience, similar to what you may be used to for Jupyter notebooks. In the meantime, we recommend using the CLI. You can try our existing extension, but please be aware that you may run into issues, and that a revamped extension is coming soon.