Vert.x - The launcher run command

Java Conceptuel Diagram


The run command (Code) is a command of the launcher.

It will:


Vertx command line

Via the vertx command line

cd /verticles # the location of the verticle jar
vertx run io.vertx.sample.RandomGeneratorVerticle 
    -cp /verticles/MY_VERTICLE.jar 

Fat jar

Via a fat jar

java -jar my-vertx-fat.jar run \
    -cluster \
    -conf myconf.json \
    -cp path/to/dir/conf/cluster_xml


Via the docker vertx-exec image

docker run -i -t -p 8080:8080 \ 
    -v $PWD:/verticles vertx/vertx3-exec \  
    run io.vertx.sample.RandomGeneratorVerticle \ 
    -cp /verticles/MY_VERTICLE.jar 


Runs a Verticle called <main-verticle> in its own instance of vert.x.

(launcher) run \
    [-cp <classpath>] \ 
    [--cluster] \
    [--cluster-host <host>] \
    [--cluster-port <port>] \
    [--cluster-public-host <public-host>] \
    [--cluster-public-port <public-port>] \
    [--conf <config>]  \
    [--ha] \
    [--hagroup <group>] \
    [--instances <instances>] \
    [--on-redeploy <cmd>] \
    [--options <options>] \ #vertx options
    [--quorum <q>] \
    [--redeploy <includes>] \
    [--redeploy-grace-period <period>] \
    [--redeploy-scan-period <period>] \
    [--redeploy-termination-period <period>]  \
    [--worker] \




  • cluster If specified then the vert.x instance will form a cluster with any other vert.x instances on the network.
  • --cluster-host <host> host to bind to for cluster communication. If this is not specified vert.x will attempt to choose one from the available interfaces.
  • --cluster-port <port> Port to use for cluster communication. Default is 0 which means choose a spare random port.
  • --cluster-public-host <public-host> - Public host to bind to for cluster communication. If not specified, Vert.x will use the same as cluster host.
  • --cluster-public-port <public-port> - Public port to use for cluster communication. Default is -1 which means same as cluster port.


  • --options <options> - Specifies the Vert.x options. (Json file or String)

There is a mapping between system properties and Vert.x Options as in:



  • --conf <config> Specifies configuration that should be provided to the verticle. (Json file or string)
  • --instances <instances> Specifies how many instances of the verticle will be deployed. Defaults to 1.
  • --worker If specified then the verticle is a worker verticle.

The deployment options of the main verticle can also be configured from system properties:

-Dvertx.deployment.options.instances=2 # 1 by default

High Avaibility

  • --ha If specified the verticle will be deployed as a high availability (HA) deployment.
  • --hagroup <group> used in conjunction with -ha this specifies the HA group this node will join. (Defaults to __DEFAULT__)
  • --quorum <q> specifies the minimum number of nodes in the cluster for any HA deploymentIDs to be active. Defaults to 1.

Hot deployment

Vert.x - Hot reloading / Live redeploy

  • --on-redeploy <cmd> Optional shell command executed when a redeployment is triggered.
  • --redeploy <includes> Enable automatic redeployment of the application. This option takes a set on includes as parameter indicating which files need to be watched. Patterns are separated by a comma.
  • --redeploy-grace-period <period> When redeploy is enabled, this option configures the grace period between 2 redeployments. The time is given in milliseconds. 1000 ms by default.
  • --redeploy-scan-period <period> When redeploy is enabled, this option configures the file system scanning period to detect file changes. The time is given in milliseconds. 250 ms by default.
  • --redeploy-termination-period <period> When redeploy is enabled, this option configures the time waited to be sure that the previous version of the application has been stopped. It is useful on Windows, where the 'terminate' command may take time to be executed.The time is given in milliseconds. 0 ms by default.

Discover More
Java Conceptuel Diagram
Vert.x - Deployment

in Vert.x You have two ways to deploy your Vert.x application. You can provide: a fat jar that contains all dependency on only the verticle when you have already a vert.x distribution. main class...
Java Conceptuel Diagram
Vert.x - High availability deployment (HA)

When a verticle is deployed in High availability mode, it can fail over to any other nodes in the cluster started with the same HA group The HA mode can be defined in a run or start command A...
Vertx Launcher Idea Run
Vert.x - Launcher class

The io/vertx/core/LauncherVertx launcher is one of the two way to start an application It is a launcher class that wraps the management of a vertx instance and the deployment of a main verticle. It can...
Java Conceptuel Diagram
Vert.x - Verticle

Verticles are the technical units of deployments of code in Vert.x. Verticles share certain similarities with actors in the actor model. Verticles communicate with each other by generating messages...
Java Conceptuel Diagram
Vert.x - Worker

A worker verticles is a verticle that is used to run blocking code. A worker verticle is not created from the pool of standard verticle and therefore will not block any event loops. Verticle DeploymentOptions...
Java Conceptuel Diagram
Vert.x - vertx command line

vertx is a command line utility tool that call the launcher class Vertx instance You get it with the full distribution where: bare resolve run As the vertx command is a wrapper...
Vertx Verticle And Lib
Vertx - Distribution Deployment

Distribution deployment is the deployment of a verticle that is based on the availability of a vertx distribution Get the Vert.x distribution Create a distribution of your application that contains:...

Share this page:
Follow us:
Task Runner