General Commands


This command connects a specific runtime from Semarchy xDI Designer console, or from the startcommand script.

connect [to <host>] [port <port>] [user <user>] [password <password>] [silent]
Option Mandatory Description

to <host>


Hostname or IP address of the host. The protocol must be included in the value, such as http://hostname or https://hostname. If not set, localhost is used.

When connecting to a local runtime that is configured to listen to localhost only, use localhost as hostname.

port <port>


Runtime port.

user <user>


User to connect with.

password <password>


Password of the user. This can be specified encrypted or as plain text.



Avoids the feedback normally written on the standard output.

The legacy uncryptedPassword parameter is deprecated. Use the password parameter instead, that accepts both a clear or encrypted value.

Runtime Version

This command returns the version of the currently connected runtime.

runtime version
The legacy versions command is deprecated. If you were using it, we recommand using the runtime version command instead.

Execute Commands

This command runs a list of commands from a file.

execute commands in file <file>
Option Mandatory Description

file <file>


Path to a file containing a list of runtime commands, with one command per line.

Example 1. Command file example
execute delivery myDelivery synch
execute delivery myDelivery2
stop runtime


This command encrypts a password and returns the encrypted string.

The output can be used in various places in Semarchy xDI, for example in action properties requiring an encrypted password, or in configuration files.

You can specify a custom encryption key defined in the runtime configuration. If no encryption key is specified, the default runtime encryption key will be used.

encrypt <password>
encrypt <password> cipheringKey <encryption_key>

Reload Modules

This command reloads the modules in the connected runtime.

You can configure automated modules reload using the moduleRefreshMode runtime parameter.

Stop Runtime

This command stops the connected runtime. The services are all stopped and all running sessions are killed.

stop runtime [wait sessions]
Option Mandatory Description

wait sessions


When this option is specified, the runtime waits for all the running sessions to complete before stopping. During that period, no additional session may be started on the runtime.

Kill Runtime

This command kills the currently connected runtime.

kill runtime
The kill command does not wait for sessions to complete.


This command shows the list of available commands or the description of a specific one.

help [on <commandName>]




on <commandName >


Shows the help of a specific command.