PlantUML Editor VSCode: Complete Setup Guide (Free)

Setting up the plantuml editor vscode extension is the fastest way to bring diagram-as-code into your daily workflow. Instead of switching to a browser tab, you write PlantUML syntax in a .puml file and see a live diagram preview beside your code — no extra context-switching needed.

The plantuml editor vscode extension — published as jebbs.plantuml on the VS Code Marketplace — has been downloaded over 15 million times. It supports every major UML diagram type with live preview, PNG and SVG export, and keeps your diagrams version-controlled alongside your codebase.

This guide covers every step — from install and Graphviz config to server mode, export, IntelliJ setup, Mac steps, and offline options. By the end you will have your first diagram generating in under ten minutes.

What Is the PlantUML Editor VSCode Extension?

The plantuml editor vscode extension — officially named jebbs.plantuml on the VS Code Marketplace — transforms Visual Studio Code into a full diagram-as-code environment. You write PlantUML syntax in a .puml file, press Alt+D, and a live diagram renders in a split panel beside your code.

It was created by developer jebbs and has accumulated over 15 million installs, making it by far the most popular PlantUML integration for any IDE. Unlike a browser-based tool, the extension keeps your diagrams local and tracked in Git alongside your source code.

For quick testing or when you prefer zero setup, our free PlantUML generator delivers the same live-preview experience directly in your browser without any installation.

How to Install the PlantUML Editor VSCode Extension

Installation takes under two minutes. The extension is available on the Visual Studio Code Marketplace and installs directly from inside the editor — no file downloads or restarts required.

• 1
  Open the Extensions Panel

  Press Ctrl+Shift+X on Windows and Linux, or Cmd+Shift+X on Mac. The Extensions sidebar opens on the left of your editor window.

• 2
  Search for PlantUML

  Type PlantUML in the search box. The top result should be “PlantUML” by jebbs (identifier: jebbs.plantuml). Check the publisher name to confirm you have the correct extension.

• 3
  Click Install

  Click the blue Install button. VS Code downloads and activates the extension automatically. No restart is required in most cases.

• 4
  Create a Test File

  Create a new file and save it with the .puml extension. Type @startuml, press Enter, type Alice -> Bob : Hello, press Enter, then type @enduml to write your first diagram.

• 5
  Press Alt+D to Preview

  With your .puml file open, press Alt+D (Windows/Linux) or Option+D (Mac). A diagram preview panel opens beside your code and updates as you type.

Configuring the PlantUML Editor VSCode Extension with Graphviz

After installing the plantuml editor vscode extension, the first decision is your render mode: server mode (easiest, no Java required) or local mode (faster, works offline, requires Java and Graphviz). Most beginners should start with server mode.

To configure server mode, open VS Code Settings (Ctrl+,), search for plantuml, and set the Render option to PlantUMLServer. Then set the Server field to the official endpoint. Your diagrams will render through the PlantUML official server with no local dependencies.

For local mode, you must install Graphviz separately and add it to your system PATH. Download the appropriate installer for your OS from the official Graphviz site, install it, and then confirm it is available by running dot -version in your terminal.

PlantUML Editor VSCode: Server Mode vs Local Rendering

Choosing the right rendering mode for your plantuml editor vscode setup depends on your network access and performance needs. Server mode requires an internet connection on every render. Local mode runs entirely on your machine once configured, with faster response times for large diagrams.

How to Preview Your Diagrams in PlantUML Editor VSCode

Previewing diagrams in VS Code is designed to require minimal steps. Once your .puml file is open and the extension is configured, you have three ways to trigger the preview panel without leaving the editor.

• 1
  Keyboard Shortcut (Fastest)

  Press Alt+D on Windows and Linux, or Option+D on Mac. A preview panel opens beside your code editor instantly. This is the recommended shortcut for daily use.

• 2
  Right-Click Context Menu

  Right-click anywhere in your open .puml file and select Preview Current Diagram from the context menu. The preview panel opens in a split view.

• 3
  Enable Auto-Refresh

  In VS Code Settings, search for plantuml.autoUpdatePreview and enable it. The preview updates automatically as you type — no shortcut needed. Useful for active editing sessions but uses more render calls.

If the preview shows a red error image, check that your @startuml and @enduml tags are present and your PlantUML syntax is correct. You can also test your code instantly in our free PlantUML diagram generator to isolate syntax issues.

Exporting PNG, SVG and PDF from the PlantUML Editor VSCode

The extension supports exporting diagrams to PNG, SVG, PDF, and plain text ASCII art. Exports are triggered through the command palette and saved to an out folder relative to your diagram file by default.

• 1
  Open the Command Palette

  Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac) to open the VS Code command palette while your .puml file is the active tab.

• 2
  Run the Export Command

  Type PlantUML: Export Current Diagram and press Enter. A format picker appears. Select png, svg, or pdf depending on where you plan to use the diagram.

• 3
  Find Your Exported File

  The exported diagram is saved to the out subfolder in the same directory as your .puml file. You can change the output location by setting plantuml.exportOutDir in VS Code Settings.

PlantUML Editor VSCode Tips: Shortcuts, Snippets and .puml Files

Getting the most from the extension means learning the time-saving features beyond basic preview and export. It includes built-in snippets, autocomplete, and keyboard bindings that significantly speed up diagram creation.

Supported file extensions for the extension are .puml, .pu, .wsd, .iuml, and .plantuml. All of these trigger the live preview when opened. Most teams standardise on .puml for consistency across IDEs and documentation pipelines.

Setting Up PlantUML Editor in IntelliJ and JetBrains IDEs

If your team uses IntelliJ IDEA, Rider, PyCharm, or another JetBrains IDE, the PlantUML integration plugin delivers a similar experience to the plantuml editor vscode setup. It installs from the JetBrains Plugin Marketplace with no extra configuration required on most systems.

To install: open your JetBrains IDE, go to Settings → Plugins → Marketplace, search for PlantUML integration, and click Install. Press Alt+D in any open .puml file to preview. The plugin uses a bundled Graphviz binary on Windows, so local rendering works without a separate Graphviz install on that platform.

The key difference is the absence of server-mode configuration in the JetBrains version — it renders locally by default. If you work across both IDEs, the .puml file format is identical, so diagrams are fully portable between editors.

PlantUML Editor VSCode on Mac: Homebrew and Java Setup

Setting up local render mode on Mac requires Java and Graphviz, both easiest to install via Homebrew. These steps apply to Intel and Apple Silicon Macs running macOS Monterey or later.

• 1
  Install Homebrew (If Not Already Installed)

  Open Terminal and run: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)". Follow the prompts. Homebrew is the standard package manager for macOS development tools.

• 2
  Install Java via Homebrew

  Run brew install openjdk in Terminal. After install, run sudo ln -sfn /opt/homebrew/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk to create the required system symlink for Java wrappers.

• 3
  Install Graphviz via Homebrew

  Run brew install graphviz. Confirm it installed correctly by running dot -version in Terminal. You should see the Graphviz version number printed without errors.

• 4
  Set Render Mode to Local in VS Code

  Open VS Code Settings, search for plantuml.render, and select Local. Restart VS Code. Open any .puml file and press Option+D to confirm local rendering is working correctly.

For a detailed walkthrough of the Mac Homebrew setup, this step-by-step community guide on DEV.to covers common Java path issues and Graphviz version conflicts specific to Apple Silicon.

Running PlantUML Editor Without Java: Offline and Docker Options

If installing Java is not an option — due to corporate policy, locked-down machines, or personal preference — you have two viable paths. The first is server mode pointing to a self-hosted PlantUML server running in Docker. The second is using our browser-based PlantUML generator online, which eliminates the Java dependency entirely.

To self-host a local PlantUML server with Docker, run: docker run -d -p 8080:8080 plantuml/plantuml-server:jetty. This starts a local server on port 8080. In VS Code Settings, set plantuml.render to PlantUMLServer and plantuml.server to http://localhost:8080. You now have full offline rendering without installing Java directly.

For teams that just need to share or preview PlantUML diagrams without any IDE setup, our free online PlantUML diagram generator at aitoolsynergy.com supports all seven major diagram types and works in any browser with zero configuration. It is a practical complement to a full IDE workflow.

No matter which approach you choose, the PlantUML syntax you write is identical. Diagrams created in VS Code, in the Docker server, or in our free online tool use the same @startuml / @enduml structure — so you can switch environments at any time without rewriting any code.

Related Articles