3.1. Command Line Parameters

General syntax

>  rce --[RCE arguments] -[RCP arguments] -[VM arguments]

Table 3.1. Command line arguments for RCE

ArgumentTypeDescription
profile "<profile id or path>"RCESets a custom profile folder to use. If only an id (any valid directory name) is given, the profile directory "<user home>/.rce/id" is used. Alternatively, a full filesystem path can be specified.
profileRCEIf the profile argument is specified without a profile id or path, RCE launches the Profile Selection UI, which allows to select a profile folder for the startup as described in ???.
batch "<command string>"RCEBehaves like the "exec" command, but also implies the "--headless" option and always shuts down RCE after execution.
headlessRCEStarts RCE in a headless modus without GUI. It will remain in the OSGi console and waits for user input.
exec "<command string>"RCE

Executes one or more shell commands defined by <command string>. For the list of available commands, refer to the command shell documentation. This argument is usually used together with --headless to run RCE in batch mode. Multiple commands can be chained within <command string> by separating them with " ; " (note the spaces); each command is completed before the next is started.

You can use the "stop" command at the end of the command sequence to shut down RCE after the other commands have been executed. However, any error during execution of these commands will cancel the sequence, and prevent the "stop" command from being executed. To ensure shut down at the end of the command sequence, use the --batch option instead of "--exec".

As an example, rce --headless --exec "wf run example.wf ; stop" will execute the "example.wf" workflow in headless mode and then shut down RCE. However, if the workflow fails to start, RCE will keep running, as the "stop" command is never executed. To attempt execution of the workflow file, but then always shut down regardless of the outcome, use rce --batch "wf run example.wf" instead.

configureRCEStarts the RCE Configuration UI (Section 2.2.4, “Configuration UI”) which can be used to configure SSH accounts with passphrases or to configure e-mail support for the RCE instance.
data @noDefault RCPSet the default workspace location to empty
consoleLog RCPLogs everything for log files on the console as well.
consoleRCPRuns RCE with an additional OSGi console window, which allows you to execute RCE shell commands. See the Command Shell documentation for more information.
Deprecated: console <port>RCPSpecify the port that will be used to listen for telnet connections. (NOTE: this access is insecure; configure SSH access instead)
clean RCPCleans before startup
vmargsVMStandard JVM arguments
Dde.rcenvironment.rce.configuration.dir=<insert-config-path>VMSets the configuration directory
Drce.network.overrideNodeId =<some-id>VM

Sets the local node id, overriding any stored value. This is mostly used for automated testing.

Example: "-Drce.network.overrideNodeId=a96db8fa762d59f2d2782f3e5e9662d4"
Dcommunication.uploadBlockSize=<block size in bytes>VM

Sets the block size to use when uploading data to a remote node. This is useful for very slow connections (less than about 10 kb/s) to avoid timeouts. The default value is 262144 (256 kb).

Example: "-Dcommunication.uploadBlockSize=131072" - sets the upload block size to 128kb (half the normal size)