Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw


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

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

PlantUML for the impatient

The easiest way to test PlantUML is in an online solution that has PlantUML embedded, such as our online server.

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

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

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

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

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

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

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

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

WARNING
 This translation need to be updated. 
WARNING

Local installation

After testing, you may want to install PlantUML locally.

You need these things to run PlantUML:

Installed the above? Then simply download plantuml.jar and run it to open PlantUML's graphical user interface. There is no need to unpack or install anything.

コマンドラインから使う

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

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

@startuml
Alice -> Bob: test
@enduml

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

java -jar plantuml.jar sequenceDiagram.txt

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

Run PlantUML from the command line

Use PlantUML's command line syntax to include it in your own scripts or documentation tools.

  1. Create a text file with PlantUML commands, like this example called sequenceDiagram.txt:

@startuml
Alice -> Bob: test
@enduml

2. Run (or have your software call) PlantUML, using sequenceDiagram.txt as input. The output is an image, which either appears in the other software, or is written to an image file on disk.
For example:

java -jar plantuml.jar sequenceDiagram.txt

This outputs your sequence diagram to a file called sequenceDiagram.png.


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.