Skip to main content

How can I run Synergy 1 from the command line?

Updated

Written for Synergy 1 (v1.21.4), checked 3 October 2026.

Note: this is for more advanced users.

Running Synergy 1 from the command line is useful in enterprise environments where you want to configure the software for an end user through files.

Requirements

  1. Synergy 1 installed on each computer: Start here: Install and configure
  2. Permission to run commands
  3. A text config file for the server: Creating and using text config files

Write a settings file

The Synergy 1 core (synergy-core) takes the mode on the command line and reads everything else from a settings file. Create a plain text file for each computer.

Server (replace the name and path with your own):

[core]
computerName=desk-pc

[server]
externalConfig=true
externalConfigFile=/path/to/synergy-server.conf

Client (replace the name and the server's IP address with your own):

[core]
computerName=laptop

[client]
remoteHost=192.168.1.10

Each computerName must match that computer's name in the server's config file. The connection uses port 24800 unless you add port= under [core] on both computers.

The simplest way to get every other setting right (encryption, logging) is to set Synergy 1 up in the app first, then copy its settings file and edit it. By default it's at:

Windows %APPDATA%\Synergy\Synergy.conf
macOS ~/Library/Synergy/Synergy.conf
Linux ~/.config/Synergy/Synergy.conf

Run the core

Quit the Synergy 1 app first: only one copy of synergy-core can run at a time.

Move (cd) into the installation directory:

Operating system Command
Windows 
cd "C:\Program Files\Synergy"
macOS 
cd /Applications/Synergy.app/Contents/MacOS/
Linux 
cd /usr/bin

Running in server mode:

Operating system Command
Windows 
synergy-core server --settings [path to settings file]
macOS 
./synergy-core server --settings [path to settings file]
Linux 
./synergy-core server --settings [path to settings file]

Running in client mode:

Operating system Command
Windows 
synergy-core client --settings [path to settings file]
macOS 
./synergy-core client --settings [path to settings file]
Linux 
./synergy-core client --settings [path to settings file]

[path to settings file] is unique to your setup, and is entered without square brackets ([]).

Command line options

Run synergy-core --help to see them. They are:

synergy-core server|client [options]

-s, --settings <file>   use this settings file
--new-instance          skip the check for a running instance
-h, --help              display help
-v, --version           display version information

Related to

Related articles