User Manual    [Previous]   [Next]   

Umple Tools

Umple files conventionally use the extension .ump. You use one or more of the following tools to edit, view and compile sets of .ump files.

• UmpleOnline. UmpleOnline allows you to instantly experiment with Umple on the web. You can explore examples or create your own and save them in the "cloud". You can generate diagrams, code in several languages and several other outputs. The UmpleOnline section of this User manual describes how to use UmpleOnline. Note that UmpleOnline can be run locally on your machine by using a Docker image. See the DockerHub page for information.


• Command-line based compiler You can use Umple from the command line. The following are some ways to install it:
  • Latest version: Download this to run same Umple version as on UmpleOnline; it is typically updated a few times each month. After downloading, run using Java 11 or later using

    java -jar umple.jar filename.ump

  
  
  • Stable release: Download this if you want to use our latest official release; typically updated 1-4 times per year.
  
  
  • Homebrew installation:Run

    brew install umple

    on a Mac (also available for Linux). This will install the latest stable release, and will update automatically after any new release. Once installed, run as

    umple filename.ump

  
  
  • Windows versions on chocolatey and Linux versions under apt may be available.
  
  The command line compiler has numerous options, including: to obtain help (--help), to generate any of Umple's possible outputs (-g), to compile the generated code to an executable (-c -), to specify suboptions to control details of generated code (-s), and to specify umple code to compile directly on the command line (rather than from a file) (-u). The command line compiler can handle thousands of files and millions of lines of Umple code if needed (Umple is written in itself, demonstrating this works well). The command line compiler can be incorporated into product toolchains using technology like Gradle or ant.


• Plugin for the Zed text editor. See the Zed page in this user manual..


• Plugin for Visual Studio Code. This plugin allows basic editing and compilation of Umple in Visual Studio Code. This will be replaced by a superior plugin soon.


• Plugin for Sublime Text. Try this Umple Plugin if you use Sublime Text.


• Plugin for Eclipse. To use Umple with Eclipse, you need to load an Umple Eclipse plugin. This can be obtained from our downloads site. It has not been maintained recently and support may be dropped.

More details on downloading, installing and running Umple can be found here.