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: pycharm plugin (#10283)
Akshay Agrawalafa630fdaa31
diff --git a/README.md b/README.mdindex 98df1ecad6..a286837036 100644--- a/README.md+++ b/README.md@@ -54,7 +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/)+- 🧑💻 **use your favorite editor**: run in [VS Code/Cursor](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo) or [PyCharm](https://plugins.jetbrains.com/plugin/32416-marimo), or edit in neovim, Zed, [or any other text editor](https://docs.marimo.io/guides/editor_features/watching/)```pythonpip install marimo && marimo tutorial intro@@ -140,6 +140,7 @@ statically analyzing your code.**Batteries-included.** marimo comes with GitHub Copilot, AI assistants, Ruffcode formatting, HTML export, fast code completion, a [VS Codeextension](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo),+a [PyCharm plugin](https://plugins.jetbrains.com/plugin/32416-marimo),an interactive dataframe viewer, and [many more](https://docs.marimo.io/guides/editor_features/index.html)quality-of-life features.diff --git a/docs/getting_started/installation.md b/docs/getting_started/installation.mdindex 44febc2356..8573d32249 100644--- a/docs/getting_started/installation.md+++ b/docs/getting_started/installation.md@@ -40,11 +40,13 @@ detailed information on using marimo with `uv`, see our [uvguide](../guides/package_management/using_uv.md).///-/// admonition | Prefer VS Code/Cursor?+/// admonition | Use our editor extensionstype: 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.+Try our [VS Code+extension](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo),+which works in VS Code, Cursor, and other VS Code forks, or our [PyCharm+plugin](https://plugins.jetbrains.com/plugin/32416-marimo).///diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.mdindex 3765275121..fdb0b5071a 100644--- a/docs/getting_started/quickstart.md+++ b/docs/getting_started/quickstart.md@@ -162,9 +162,9 @@ 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)).-## VS Code/Cursor extension+## Editor extensions-You can edit and run marimo notebooks in VS Code or Cursor using our+**VS Code/Cursor.** You can edit and run marimo notebooks in VS Code or Cursor using ourextension; this provides a user interface that's similar to VS CodeJupyter, but with marimo's reactive execution, interactive elements,built-in package management, Git-friendly file format, and more.@@ -174,3 +174,9 @@ Install the extension by searching "marimo" in the extensions sidebaror 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>++**PyCharm.** Our [PyCharm+plugin](https://plugins.jetbrains.com/plugin/32416-marimo), available on the+JetBrains Marketplace, brings the full marimo editor inside PyCharm, letting you open, edit, and+run notebooks without leaving your IDE.+diff --git a/docs/guides/editor_features/watching.md b/docs/guides/editor_features/watching.mdindex f04e235895..4e34339f91 100644--- a/docs/guides/editor_features/watching.md+++ b/docs/guides/editor_features/watching.md@@ -7,13 +7,14 @@ 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.-/// admonition | Prefer VS Code/Cursor? Try our extension!+/// admonition | Use our editor extensionstype: tipThis 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.+If you use VS Code, Cursor, or PyCharm, you might prefer using our [VS Code+extension](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)+or [PyCharm plugin](https://plugins.jetbrains.com/plugin/32416-marimo), which+provide first-class experiences for editing and running marimo notebooks.///## marimo's file formatdiff --git a/docs/index.md b/docs/index.mdindex 8d660a0fac..88dd23a5f3 100644--- a/docs/index.md+++ b/docs/index.md@@ -179,6 +179,7 @@ statically analyzing your code.**Batteries-included.** marimo comes with [GitHub Copilot](guides/editor_features/ai_completion.md#github-copilot), AI assistants, Ruffcode formatting, HTML export, fast code completion, a [VS Codeextension](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo),+a [PyCharm plugin](https://plugins.jetbrains.com/plugin/32416-marimo),an interactive dataframe viewer, and [many more](guides/editor_features/index.md)quality-of-life features.