このページにコントリビュートすることができます。  (Menu)

 

 

PlantUML をとりあえず使ってみたい人へ

最もかんたんで素早く PlantUML を使ってみたい人は、 PlantUML オンラインサーバ を使ってみてください。

 

 

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

一度は PlantUML をローカルにインストールしたい!と思ったこともあるでしょう。

詳しいことは、インストールガイドをご覧ください。

ここでは、概要を説明します。

自分の環境に Java をインストールしておいてください。 また、シーケンス図とアクティビティ図 以外 のダイアグラムを使いたい場合は、Graphviz software もインストールしてください。

そしたら、plantuml.jarをダウンロードしてください。この .jar 実行ファイルが PlantUML 本体です。

インストールできたかをかんたんに確認する方法は、 ダウンロードした .jarファイルをダブルクリックし GUI を起動させてみることです。

以上で、PlantUML のコードを書いたファイルやドキュメンテーションツールから使用できるようになりました。

 

 

コマンドラインから使う

実際にコマンドラインで実行してみる手順も書いておきましょう

まず、以下のような内容の sequenceDiagram.txt というファイルを作りましょう。

@startuml
Alice -> Bob: test
@enduml

次に、コマンドライン(Windows なら cmd.exe や powershell 、Mac ならターミナル)から以下のコマンドを実行してください。

java -jar plantuml.jar sequenceDiagram.txt

そうすると、 sequenceDiagram.png という画像ができているはずです。