Skip to content

marimo: add page #16024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 27, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions pages/common/marimo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# marimo

> A reactive Python notebook environment.
> Combines features of Jupyter, Streamlit, and other notebook tools with reactive execution.
> More information: <https://docs.marimo.io/cli>.

- Create or edit notebooks by starting a marimo server:

`marimo edit`

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

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

- Edit a specific notebook:

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

- Run a marimo notebook as an app in read-only mode:

`marimo run {{path/to/notebook.py}}`

- Start an interactive tutorial to learn marimo:

`marimo tutorial {{intro|components|dataflow|io}}`

- View command specific help:

`marimo {{edit|run|tutorial|config|new|...}} --help`