Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.83 KB

README.md

File metadata and controls

58 lines (42 loc) · 3.83 KB
Raw

vscode marimo

Visual Studio Marketplace Version

Run marimo, directly from VS Code.

Note

This extension requires marimo to be installed on your system: pip install marimo. See the installation guide for more details.

Check out the marimo documentation at https://docs.marimo.io/.

Features

  • 🚀 Launch marimo from VS Code, in both "edit mode" and "run mode".
  • 💻 View the terminal output of marimo directly in VS Code.
  • 🌐 View the marimo browser window directly in VS Code or in your default browser.
  • 📥 Export notebooks as: html, markdown, or scripts.
  • 📓 Convert Jupyter notebooks to marimo notebooks.
  • 🧪 [experimental] Run marimo in VSCode's native notebook

Known Issues

VS Code's embedded browser does not support all native browser features. If you encounter any issues, try opening marimo in your default browser instead. For example, the embedded browser will not support PDF render, audio recording, video recording, and some copy/paste operations.

Experimental Native Notebook

This extension includes an experimental feature to run marimo in VSCode's native notebook interface. This feature lets you use VSCode editors and extensions for writing code while the outputs and visualizations are rendered in a view-only marimo editor. This marimo editor displays outputs, console logs, and UI elements to interact with.

This feature is experimental and may have some limitations. Some known limitations are:

  • VSCode automatically includes "Run above" and "Run below" buttons in the notebook toolbar. While these work, they do not make sense with a reactive notebook.
  • Notebooks can still be edited even though there may not be an active marimo server. This can be confusing since saving or running will not work.
  • For autocomplete to work when using native VSCode notebooks for many packages (including marimo, numpy, and more) you may be required to include a pyproject.toml file at the root of the workspace. marimo's editor gets around this by default but unfortunately, the VSCode's native notebook does not.
  • You cannot access many marimo features in the native notebook (and need to use the marimo browser), such as the variable explorer, dependency viewer, grid mode (plus other layouts), and more - so we show the notebook in "Kiosk Mode" which is a read-only view of the outputs and helper panels.

Extension Settings

You can configure the extension using the following settings:

  • marimo.browserType: Browser to open marimo app (system or embedded, default: embedded)
  • marimo.port: Default port for marimo server (default: 2818)
  • marimo.sandbox: Always start marimo in a sandbox, e.g. marimo edit --sandbox (default: false). Requires uv to be installed.
  • marimo.host: Hostname for marimo server (default: localhost)
  • marimo.https: Enable HTTPS for marimo server (default: false)
  • marimo.enableToken: Enable token authentication (default: false)
  • marimo.tokenPassword: Token password (default: empty)
  • marimo.showTerminal: Open the terminal when the server starts (default: false)
  • marimo.debug: Enable debug logging (default: false)
  • marimo.pythonPath: Path to python interpreter (default: the one from python extension)
  • marimo.marimoPath: Path to marimo executable (default: marimo)