Installing marimo gets you the marimo command-line interface (CLI), the entry
point to all things marimo.
marimo tutorial intro opens the intro tutorial. List all tutorials with
marimo tutorial --helpCreate 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.)
Use marimo run to serve your notebook as an app, with Python code hidden and
uneditable.
marimo run your_notebook.pyAutomatically convert Jupyter notebooks to marimo notebooks with marimo convert:
marimo convert your_notebook.ipynb -o your_notebook.pyThen open the notebook with marimo edit your_notebook.py
!!! tip "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 `~/.marimo.toml` or `$XDG_CONFIG_HOME/marimo/marimo.toml`.
3. Update your config to include the following:
```toml title="marimo.toml"
[runtime]
auto_instantiate = false
```
Use
marimo exportto convert marimo notebooks to other file formats, including HTML, IPYNB, and markdown.
Some features require additional dependencies, which are not installed by default. This includes:
- SQL cells
- Charts in the datasource viewer
- AI features
- Format on save
To install the optional dependencies, run:
/// tab | install with pip
pip install "marimo[recommended]"///
/// tab | install with uv
uv pip install "marimo[recommended]"///
/// tab | install with conda
conda install -c conda-forge marimo duckdb altair polars openai ruff///
This will install: duckdb, altair, polars, openai, and ruff.
The marimo editor natively supports GitHub Copilot, an AI pair programmer, similar to VS Code.
Get started with Copilot:
- Install Node.js.
- 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.
The best way to use marimo is through the CLI. However, 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.
