Home page¶
Running marimo edit without a filename opens the home page, which lets you
browse and manage notebooks in a directory.
Usage¶
# Open home page for current directory
marimo edit
# Open home page for a specific folder
marimo edit folder/
The home page shows all marimo notebooks in the directory, letting you:
- Open existing notebooks
- Create new notebooks
- See notebook metadata
Sandboxed Home¶
You can open a directory in sandbox mode, giving each notebook its own isolated environment:
Each environment is prepared from the notebook's requirements when you open it. See working in sandboxes for setup with uv or Pixi.
Using custom virtual environments¶
You can specify an existing virtual environment for each notebook when editing
a directory or a single notebook with marimo edit --no-sandbox.
This is configured using [tool.marimo.venv] in your script metadata:
# /// script
# [tool.marimo.venv]
# path = "path/to/venv" # relative or absolute path
# writable = false # optional, default is false
# ///
With --sandbox, uv or Pixi provisions the environment from the notebook's
manifest. The editor ignores [tool.marimo.venv] and prints a warning.
Use --no-sandbox to use the configured environment. To use an activated
environment directly, see
using an existing environment.
Configuration options¶
| Option | Description |
|---|---|
path |
Path to the virtual environment (relative or absolute) |
writable |
Whether marimo can install packages into the venv (default: false) |
Behavior¶
writable |
marimo installed? | What happens |
|---|---|---|
true |
- | marimo installs itself and required dependencies into the venv |
false |
Yes | Uses the venv as-is (warns if marimo version differs) |
false |
No | Injects PYTHONPATH for marimo (requires matching Python version) |
This is useful when:
- You have a conda or poetry environment you want to reuse
- You're working in a team with a shared environment
- You want notebooks in a folder to use different pre-configured environments