marimo

(★ 22,419)

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

File Explorer

Showing a partial file list — download the zip above to see everything.

  • .env.testing
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
  • .gitpod.yml
  • .oxfmtrc.json
  • .pre-commit-config.yaml
  • .python-version
  • AGENTS.md
  • CITATION.cff
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CODEOWNERS
  • CONTRIBUTING.md
  • DESIGN.md
  • GOVERNANCE.md
  • LICENSE
  • Makefile
  • MANIFEST.in
  • README.md
  • README_Chinese.md
  • README_Japanese.md
  • README_Spanish.md
  • README_Traditional_Chinese.md
  • SECURITY.md

# Installation Guide

python
Prerequisites

Setup Steps

pip install marimo

Install marimo using the Python package manager.

marimo tutorial intro

Run the introductory tutorial to verify the installation.

marimo edit

Launch the editor to create or edit notebooks.

Video Guides

marimo concepts playlist

Key Commands

pip install marimo

Install the basic marimo package.

pip install "marimo[recommended]"

Install marimo with recommended extra features like SQL and AI.

marimo edit

Open the marimo editor web interface.

marimo run your_notebook.py

Run a notebook script as a web application.

Installing with the "marimo[recommended]" option is recommended to unlock extra features.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Showing a partial file list.

Release Timeline

Actively Maintained

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

jupyter

View Details ▼

Web application to create and share documents that contain code, visualizations, and notes.
Primarily used for data analysis, scientific computing, and machine learning.

jupyter notebook

Start a Jupyter notebook server in the current directory:

jupyter notebook {{path/to/file}}.ipynb

Open a specific Jupyter notebook:

jupyter nbconvert --to {{html|markdown|pdf|script|...}} {{path/to/file}}.ipynb

Export a specific Jupyter notebook into another format:

🔍

jupytext

View Details ▼

Convert Jupyter notebooks to plain text documents, and back again.

jupytext --set-formats ipynb,py {{path/to/notebook}}.ipynb

Turn a notebook into a paired `.ipynb`/`.py` notebook:

jupytext --to py {{path/to/notebook}}.ipynb

Convert a notebook to a `.py` file:

jupytext --to notebook {{path/to/notebook}}.py

Convert a `.py` file to a notebook with no outputs:

🔍

marimo

View Details ▼

A reactive Python notebook environment.
Combines features of Jupyter, Streamlit, and other notebook tools with reactive execution.

marimo edit

Create or edit notebooks by starting a marimo server:

marimo edit {{[-p|--port]}} {{port_number}} --headless

Start a marimo server on a specific port without launching a browser:

marimo edit {{path/to/notebook.py}}

Edit a specific notebook:

🔍

pip install

View Details ▼

Install Python packages.

pip install {{package1 package2 ...}}

Install one or more packages:

pip install {{package1 package2 ...}} {{[-U|--upgrade]}}

Upgrade all specified packages to the latest version, installing any that are not already present:

pip install {{package}}=={{version}}

Install a specific version of a package:

🔍

python

View Details ▼

Python language interpreter.

python

Start a REPL (interactive shell):

python {{path/to/file.py}}

Execute a specific Python file:

python -i {{path/to/file.py}}

Execute a specific Python file and start a REPL:

🔍

streamlit

View Details ▼

Framework for creating interactive, data-driven web apps in Python.

streamlit hello

Check for the Streamlit installation:

streamlit run {{project_name}}

Run a Streamlit application:

streamlit --help

Display help:

// repository documentation