Command Line Options

The EventGhost main executable accepts the following command line arguments:

-configdir <directory>

Instructs EventGhost to use the directory <directory> to store and retrieve its settings. Without this option EventGhost uses a directory in the application data folder of your machine for storing its settings. For example, through this option you can change the folder to a location on a USB stick to allow EventGhost to be used in a portable manner.

-debug

Start EventGhost in verbose mode and log to a file located in the %AppData%\EventGhost folder.

-d

Shorter alias for the -debug option.

-event <eventname> [<payload> ...]

Issues the event <eventname> in the currently running EventGhost instance. Optionally you can specify one or more <payload> strings, that will be added to the event in the eg.event.payload field.

-e <eventname> [<payload> ...]

Shorter alias for the -event option.

-file <filename>

Opens the configuration file <filename>. The -file is not required, EventGhost will open any file with the .egtree or .xml extension passed as a command line argument.

-f <filename>

Shorter alias for the -file option.

-hide

Starts EventGhost hidden in the system tray or minimized, depending on your setting in File ‣ Options ‣ Display EventGhost icon in system tray. Otherwise it would start in the state it had when it was closed.

-h

Shorter alias for the -hide option.

-multiload

Allow multiple sessions of EventGhost on the same computer.

-m

Shorter alias for the -multiload option.

-netsend <host>:<port> <password> <eventname> [<payload> ...]

This one is similar to the -event option, but sends the event <eventname> through TCP/IP like the ‘Network Event Sender’ plugin does. It will not start EventGhost, so it can be used as a little helper tool for other applications or .BAT files to send events to a remote machine. <host> has to be the IP or host name of the target machine. <port> and <password> are the options that you have configured on the target machine’s ‘Network Event Receiver’ plugin.

-n <host>:<port> <password> <eventname> [<payload> ...]

Shorter alias for the -netsend option.

-plugin <egplugin>

Opens the plugin archive file <egplugin> for installation in EventGhost. Plugins installed through a <egplugin> plugin archive file are stored in the %AppData%\EventGhost\plugins folder and take precedence over plugins in the %ProgramFiles%\EventGhost\plugins folder. The -plugin is not required, EventGhost will open any file with the .egplugin extension passed as a command line argument.

-p <egplugin>

Shorter alias for the -plugin option.

-plugindir <directory>

Instructs EventGhost to use the directory <directory> to load additional plugins.

-restart

Restart EventGhost.

Note

If you started EventGhost with full elevation you must also run this commands with full elevation.

-translate

Starts EventGhost’s translation editor.