Downloading and installing Umple

Below are instructions for downloading and installing Umple, a model-oriented programming technology that lets you model in code. Here is more information about Umple, or try it online without downloading, using the UmpleOnline tool.

Umple can be used on Mac-OS, Windows or Linux. You have several downloading options described below, including directly downloading a jar, using homebrew, using Docker, using VSCode, or using Eclipse

To obtain the full tree with source code go to Umple's Github main page. The list of recent changes can be found by clicking here

A. Downloading Umple for Command-Line use

Prerequisite dependency: An up-to-date Java 8 JDK or higher. The compiler has been tested and is also known to work under Java versions up to Java 16. If Java is not installed, then on Ubuntu first run apt install default-jdk or on Mac run brew install openjdk or on Windows choco install openjdk .

Options:

• The latest build of the command-line compiler from continuous integration.
   
  This is built after every merge to master from our continuous build process, which can occur as frequently as every few hours, or as infrequently as every few weeks, depending on season. This version is thoroughly tested and will always contain the latest enhancements and fixes. This is also the version of the compiler used by UmpleOnline
   
  
• The latest official releases of the Umple command-line jar at GitHub, along with release notes
   
  Use one of these releases if you need complete stability in the code generated from Umple. New releases are made 2-4 times a year.
   
  
• On MacOS and Linux you can install the most recent release of the Umple command line compiler using Homebrew. This will also set yourself up to obtain later releases automatically. If you haven't installed Homebrew, you can install it using the directions at https://brew.sh ... and then do  
  

  brew install umple

  After running this, there will be a command umple that executes the Umple jar file

  Note that this will try to install openjdk as a dependency in homebrew first (if not already there), so it may take some time. If you have java installed outside of homebrew, you can avoid an unneeded installation by specifying --ignore-depenencies and then adding a symbolic link to the existing java executable when if you receive a message saying that the homebrew java command cannoth be found.

To run the Umple compiler on the command line

• Run
  

  java -jar umple.jar <options> <files>

  
  or if you have downloaded Umple using Homebrew or have installed the umple wrapper script some other way you can simply specify
  

  umple <options> <files>

  
  
• Specify your umple file as an argument (more than one is allowed). The .ump suffix must be used. One umple file can invoke another using the use statement. You can also specify the names of mixsets to activate them.
   
  
• You can use --help as an option to obtain the full set of command-line options. The most popular available include:
  • -g, --generate lang : Specify the output language (Java is the default; to ensure no output is generated, specify the word 'nothing' literally): Java,RTCpp, Php, Ruby,SQL,Json,Ecore,TextUml,Scxml Yuml, etc.
  • --help : Display the help message
  • --override : If a output language is specified using option -g, output will only generate language
  • --path : If a output language is specified using option -g, output source code will be placed to path
  • -u, --umple "code" : Specify a valid umple program directly on the command line (can be used add extra information to the files supplied as arguments).
  • -v, --version : Print out the current Umple version number
  • -c - : Compile the generated code (i.e. go directly from Umple to an executable system in Java, or to verify the syntax of generated PhP)

B. Running UmpleOnline in your own computer's Docker installation

Requirement: Docker installed on your computer.

Umple provides a Docker image of Umpleonline that allows you to explore all the features of Umple through a web browser, with the server running locally on your computer. To use this, do the following after installing Docker. Further information can be found on Umple's Docker Hub page

• Make sure Docker is actually running on your computer
• Pull the latest image (do this every time, so you get any changes):

    docker pull umple/umpleonline
  

• Create a directory on your local machine to store your data (or reuse one that you had created previously for this purpose). In the example below we will use '~/umpledata'. As the image runs, a subdirectory of this will be created for each web session, containing the .ump files being edited, and the generated outputs. You can use the Umpleonline bookmarking capability to create a subdirectory within your local-machine directory that has a fixed name; you you can then access this repeatedly to keep working on the same models.
   
• In a terminal (console), invoke the image (you can change the first 8000 to be another port both here and in the next instruction if you prefer):

    docker run --rm -ti -p 8000:8000 -v ~/umpledata:/var/www/ump umple/umpleonline >/dev/null
  

• In a web browser, go to the following link: http://localhost:8000/umple.php
   
  
• To quit the image: a) If started as above in Linux or Mac, hit control-c; or b) run 'docker ps' to find the name of the running image and kill it using 'docker kill image'.

You can also accomplish the above by downloading and installing our script called udock and passing it the optional argument -d {dir} for your local storage directory (otherwise data will be stored in a temporary directory)

More information about Umple in Docker can be found at https://umple.org/docker

New Docker images are produced for each release of Umple, with occasional interim images. A list of Docker images can be found at the Umpleonline DockerHub site. The image tagged 'latest' will be downloaded by default.

C. Running in VSCode.

A Visual Studio Code plugin for Umple is available.

D. Installing and running the Umple compiler in Eclipse

Requirements: Java (as above), and the latest Eclipse with modeling tools.

Full directions for installing the Eclipse plugin can be found on this Umple Wiki Page.

The update site to install Umple in Eclipse is https://cruise.umple.org/org.cruise.umple.eclipse.plugin.update.site

E. The Umplificator

Another tool available is the umplificator, for reverse engineering code to Umple. The Umplificator can be downloaded here.

User Manual

Refer to the Umple user manual for comprehensive help programming in Umple. The API quick reference and grammar quick reference may be of particular help for power users.