UmlWriter may be installed in several ways, choose your favorite.


Before you install PHP UmlWriter, you will need an operating system with PHP 5.4.0 or later installed,

UmlWriter requires the spl extensions. This extension is usually compiled and enabled by default.


Put a file named composer.json at the root of your project, with the content below:

    "require": {
        "bartlett/umlwriter": "^1.2"

And ask Composer to install the dependencies:

$ php composer.phar install

Or just invoke Composer to install the latest version:

$ php composer.phar require bartlett/umlwriter

You can also use Composer to create a new project from an existing UmlWriter package. This is the equivalent of doing a git clone checkout followed by a composer install of the vendors.

$ php composer.phar create-project bartlett/umlwriter /path/to/install ^1.2

Where /path/to/install is your install directory.


The recommended way for newbies, or just to have a look on features of this library, is to download a PHP Archive that contain all required dependencies of PHP UmlWriter bundled in a single file.

$ wget
$ chmod +x umlwriter-1.2.0.phar
$ mv umlwriter-1.2.0.phar /usr/local/bin/umlwriter
$ umlwriter

You can also immediately use the PHAR after you have downloaded it.

$ wget
$ php umlwriter-1.2.0.phar


Read more

For developers who want to extend or change UmlWriter features.

  • Want to create a new processor, have a look on processor's guide.

  • Want to create a new reverse engine, have a look on reflector's guide.