Installing marimo gets you the
marimo command-line interface (CLI), the entry point to all things marimo.
Before installing marimo, we recommend creating and activating a Python virtual environment.
Setting up a virtual environment
Python uses virtual environments to minimize conflicts among packages. Here’s a quickstart. Run the following in the terminal:
create an environment with
python -m venv marimo-env
activate the environment:
Make sure the environment is activated before installing marimo and when
using marimo. Install other packages you may need, such as numpy, pandas, matplotlib,
and altair, in this environment. When you’re done, deactivate the environment
deactivate in the terimnal.
Learn more from the official Python tutorial.
To install marimo, run the following in a terminal:
pip install marimo
To check if the install worked, run
marimo tutorial intro
A tutorial notebook should open in your browser.
marimo tutorial intro opens the intro tutorial. List all tutorials with
marimo tutorial --help
Create and edit notebooks with
create a new notebook:
create or edit a notebook with a given name:
marimo edit your_notebook.py
marimo run to serve your notebook as an app, with Python code hidden and
marimo run your_notebook.py
Convert Jupyter notebooks#
Automatically translate Jupyter notebooks to marimo notebooks with
marimo convert your_notebook.ipynb > your_notebook.py
Because marimo is different from traditional notebooks, your converted notebook
will likely have errors that you’ll need to fix. marimo will guide you through
fixing them when you open it with
The marimo editor natively supports Github Copilot, an AI pair programmer, similar to VS Code.
Get started with Copilot:
Enable Copilot via the settings menu in the marimo editor.
VS Code extension#
If you prefer VS Code over terminal, try our VS Code extension. Use this extension to edit and run notebooks directly from VS Code, and to list all marimo notebooks in your current directory.