忙しい人のためのPlantUML

PlantUMLを試したいなら、PlantUML オンラインサーバのような、オンラインでPlantUMLを使えるサービスが一番簡単な方法です。

ローカル環境にインストールする

試用後、PlantUMLをローカル環境にインストールしたい場合もあるでしょう。

PlantUMLの実行には以下の二つが必要です:

これらをインストールしたら、あとはplantuml.jarをダウンロードして実行すれば、PlantUMLのGUIインターフェースが起動します。ファイルを展開したり、何かをインストールする必要はありません。

コマンドラインから使う

PlantUMLのコマンドライン構文を使用して、他のスクリプトやドキュメンテーションツールに含めることができます。

  1. PlantUMLコマンドの書かれたテキストファイルを作成します。例えば次の例をsequenceDiagram.txtとして作成します:

@startuml
Alice -> Bob: test
@enduml

2. sequenceDiagram.txtを入力として、PlantUMLを実行(またはソフトウェアから呼び出し)します。画像が出力され、それは他のソフトウェアに渡されるか、画像ファイルとしてストレージ上に保存されます。
例:

java -jar plantuml.jar sequenceDiagram.txt

この場合、作成したシーケンス図はsequenceDiagram.pngというファイルに出力されます。