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.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
docs: vscode extension (#7219)
Akshay Agrawal03ea308ce92a
diff --git a/README.md b/README.mdindex 00f32de459..ec68bf3596 100644--- a/README.md+++ b/README.md@@ -54,6 +54,7 @@ and deployable as apps.- 🧩 **reusable:** [import functions and classes](https://docs.marimo.io/guides/reusing_functions/) from one notebook to another- 🧪 **testable:** [run pytest](https://docs.marimo.io/guides/testing/) on notebooks- ⌨️ **a modern editor**: [GitHub Copilot](https://docs.marimo.io/guides/editor_features/ai_completion.html#github-copilot), [AI assistants](https://docs.marimo.io/guides/editor_features/ai_completion.html), vim keybindings, variable explorer, and [more](https://docs.marimo.io/guides/editor_features/index.html)+- 🧑💻 **use your favorite editor**: run in [VS Code or Cursor](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo), or edit in neovim, Zed, [or any other text editor](https://docs.marimo.io/guides/editor_features/watching/)```pythonpip install marimo && marimo tutorial introdiff --git a/docs/getting_started/installation.md b/docs/getting_started/installation.mdindex 9397c94c24..f09ea36ae7 100644--- a/docs/getting_started/installation.md+++ b/docs/getting_started/installation.md@@ -36,6 +36,15 @@ detailed information on using marimo with `uv`, see our [uvguide](../guides/package_management/using_uv.md).///+/// admonition | Prefer VS Code/Cursor?+ type: tip++[Try our extension](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo),+which works in VS Code, Cursor, and other VS Code forks.+///+++## Install with minimal dependenciesTo install marimo, run the following in a terminal:diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.mdindex 5b5ef1aa21..3597005993 100644--- a/docs/getting_started/quickstart.md+++ b/docs/getting_started/quickstart.md@@ -152,11 +152,15 @@ Use [molab](https://molab.marimo.io/notebooks), a cloud-based marimo notebookservice similar to Google Colab, to create and share notebook links([docs](../guides/molab.md)).-## Coming from VS Code?--The best way to use marimo is through the CLI. While we do have a VS Code extension,-we are actively rewriting it to provide a more native and robust experience, similar-to what you may be used to for Jupyter notebooks. In the meantime, we recommend using-the CLI. You can try our [existing extension](-https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo), but please-be aware that you may run into issues, and that a revamped extension is coming soon.+## VS Code/Cursor extension++You can edit and run marimo notebooks in VS Code or Cursor using our+extension; this provides a user interface that's similar to VS Code+Jupyter, but with marimo's reactive execution, interactive elements,+built-in package management, Git-friendly file format, and more.++Install the extension by searching "marimo" in the extensions sidebar+(`Cmd/Ctrl-Shift-P`, type "install extension", then search "marimo")+or from the [VS Code marketplace site](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo).++<iframe width="560" height="315" src="https://www.youtube.com/embed/BOzK-XBK8A4?si=Bj_Hjuz46jGqMIrt" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>diff --git a/docs/guides/editor_features/watching.md b/docs/guides/editor_features/watching.mdindex 91e6bcdb36..6c49af7f71 100644--- a/docs/guides/editor_features/watching.md+++ b/docs/guides/editor_features/watching.md@@ -7,19 +7,17 @@ the marimo editor or running application. This lets you edit your notebookusing an editor of your choice, like neovim, VSCode, Cursor, or PyCharm, andhave the changes automatically reflected in your browser.-!!! tip "Install watchdog for better file watching"- For better performance, install [watchdog](https://pypi.org/project/watchdog/).- Without watchdog, marimo resorts to polling.+/// admonition | Prefer VS Code/Cursor?+ type: tip-!!! warn "Watch works best with autosave"- Verify your settings in `User Settings` > `Editor` > `Autosave` > `Autosave enabled`+This guide teaches you how to use marimo with arbitrary text editors.+If you use VS Code or Cursor, you might prefer using [our+extension](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo), which provides a first-class experience for editing and+running marimo notebooks.+///## marimo's file format-!!! tip "File format tutorial"-- Run `marimo tutorial fileformat` at the command line for a full guide.-marimo stores notebooks as Python files. Cells are storedas functions, decorated with`@app.cell`; you can optionally give cells names inthe editor UI or by editing the notebook file.@@ -32,6 +30,8 @@ def memorable_cell_name(auto, determined, references): # signature denotes cellreturn computed_value # return denotes cell definitions```+Run `marimo tutorial fileformat` at the command line for a full guide.+!!! note "Cell signature and returns"Don't worry about maintaining the signatures of cells and their return@@ -180,6 +180,14 @@ a library, and they cannot be run as scripts.## Watching for changes to your notebook+!!! tip "Install watchdog for better file watching"+ For better performance, install [watchdog](https://pypi.org/project/watchdog/).+ Without watchdog, marimo resorts to polling.++!!! warn "Watch works best with autosave"+ Verify your settings in `User Settings` > `Editor` > `Autosave` > `Autosave enabled`++### `marimo edit --watch`When you run `marimo edit` with the `--watch` flag, the marimo server@@ -215,11 +223,10 @@ Guide](module_autoreloading.md)## Watching for data changes-!!! info "Data file watching now supported!"- marimo now supports watching data files and automatically refreshing cells that- depend on them using `mo.watch.file()` and `mo.watch.directory()`.+marimo supports watching data files and automatically refreshing cells that+depend on them using [`mo.watch.file`][marimo.watch.file] and [mo.watch.directory][`marimo.watch.directory`].- Learn more in the [watch API documentation](../../api/watch.md).+Learn more in the [watch API documentation](../../api/watch.md).## Hot-reloading WebAssembly notebooksdiff --git a/docs/index.md b/docs/index.mdindex 8f8a1ef56f..9df935e6c4 100644--- a/docs/index.md+++ b/docs/index.md@@ -69,6 +69,7 @@ reproducibility, maintainability, composability, and shareability.- 🧩 **reusable:** [import functions and classes](guides/reusing_functions.md) from one notebook to another- 🧪 **testable:** [run pytest](guides/testing/index.md) on notebooks- ⌨️ **a modern editor**: [GitHub Copilot](guides/editor_features/ai_completion.md#github-copilot), [AI assistants](guides/editor_features/ai_completion.md), vim keybindings, variable explorer, and [more](guides/editor_features/index.md)+- 🧑💻 **use your favorite editor**: run in [VS Code or Cursor](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo), or edit in neovim, Zed, [or any other text editor](https://docs.marimo.io/guides/editor_features/watching/)## A reactive programming environment