Yedidya kfir
Yedidya kfir

Reputation: 1799

Can't render component diagram with PlantUML in IntelliJ

I am trying to create a component diagram using the PlantUML plugin for IntelliJ. I have installed the plugin and worked with it before. However, when I try to render a component diagram, I get an error:

Cannot find Graphviz

enter image description here

I've also checked with other diagrams and a sequence diagram is still working just fine.

enter image description here

What is the problem here?

Upvotes: 88

Views: 51191

Answers (7)

Tanel
Tanel

Reputation: 1510

Option 1.

On a mac using Intellij, if Intellij cannot find graphviz, testdot doesn't work and graphviz was installed with brew install graphviz:

  1. In Intellij, click the wrench icon on the far right of the menu panel that contains the plantuml view and editor arrangement.
  2. Click 'Open settings'
  3. For 'Graphviz dot executable' add /opt/homebrew/bin/dot.
  4. Click OK and restart Intellij.

This fixes the issue for me.

You can check first that you really are missing the /opt/local/bin/dot (or whatever path you're shown is broken) and the /opt/homebrew/bin/dot exists, but likely the reason is that brew put dot under its own path.

Option 2.

Found myself on this same thread while using Windows 11 having a similar issue. The puml and plantuml codeblocks weren't displaying the diagram in a markdown file, only codeblock-ed text. What solved it for me:

  1. Go to Settings in Intellij,
  2. on the left menu, select Languages & Frameworks,
  3. and under it, select Markdown

Review the Markdown Extensions section. Install and enable PlantUML there. Same solution worked for Mermaid.

Upvotes: 106

Noman
Noman

Reputation: 303

  1. First install graphviz

  2. Find dot executable and put it where IntelliJ can find it

    • Windows: Add the dot executable path in the environment variables path settings
    • Linux: find the location of dot using where dot and if it's not in the /opt/local/bin you can just create a symbolink link from lets say /usr/local/bin by running ln -s /usr/local/bin/dot /opt/local/bin/dot
  3. Restart IntelliJ

Upvotes: 2

Jimmy_Rw
Jimmy_Rw

Reputation: 1356

As mentioned here https://plantuml.com/graphviz-dot

Since version 1.2021.5, you can experimentally use PlantUML without installing Graphviz if you add !pragma layout smetana to your diagrams for the supported types. In that case, the "Smetana" engine is used instead of Graphviz

Therefore this worked for me;

@startuml
!pragma layout smetana
...
@enduml

I hope it helps!

Upvotes: 49

Binita Bharati
Binita Bharati

Reputation: 5908

In case it helps someone, these are the steps to resolve the same error (Can not find GraphViz...) from Eclipse editor.

  1. Install GraphViz on your system. Depending on your system, installation instructions are here: https://graphviz.org/download/ . For Mac (v11.6) users, it is as simple as brew install graphviz

  2. After installation is completed, add an environment variable: GRAPHVIZ_DOT to point to the path of the dot executable. On my machine, I added this:

    export GRAPHVIZ_DOT=/opt/homebrew/bin/dot

  3. Add path of the dot executable to Eclipse PlantUml preferences (Preferences --> Plant UML --> Path to the dot executable of Graph Viz). Screen shot given below:

enter image description here

Upvotes: 3

agelbess
agelbess

Reputation: 4349

I had trouble too...the easiest way is to install the VsCode plugin 'Markdown Preview Enhanced' and then...magically...IntelliJ works fine too!!!

Upvotes: 0

Jakub Ch.
Jakub Ch.

Reputation: 3727

Sequence diagrams and activity diagrams work out of the box.

For other types of diagrams, you need to have Graphviz installed (version > 2.26.3).

  1. If you don't have Graphviz installed - just install it.
  2. If you have it installed but its version is improper - reinstall it.
  3. If you have it installed in proper version but location is other than default - point to that location. You can manage that either by specifying env variable GRAPHVIZ_DOT containing a path to Graphviz executable or pointing it out directly from IntelliJ's PlantUML plugin settings.

Here, you can read more on how to install Graphviz to get along with PlantUML.

Btw. I solved the same problem by simply typing sudo apt-get install graphviz in my console - maybe would work for you as well.

Upvotes: 39

Dor Sloim
Dor Sloim

Reputation: 99

If you:

1.installed Graphviz

2.configured GRAPHVIZ_DOT env var to your dot.exe file (example D:\Program Files (x86)\Graphviz2.38\bin\dot.exe)

And you're still getting the same error: Cannot find Graphviz1. You probably need to configure the path to the dot.exe inside the Intelij settings.

Follow this tutorial to do so.

Upvotes: 8

Related Questions