2024-08-24 16:40:13 +00:00
# Synergy
2019-04-26 16:02:45 +00:00
2024-07-23 09:24:47 +00:00
[](https://sonarcloud.io/summary/new_code?id=symless_synergy-core)
2024-06-26 16:42:02 +00:00
[](https://github.com/symless/synergy-core/actions/workflows/ci.yml)
[](https://github.com/symless/synergy-core/actions/workflows/codeql-analysis.yml)
[](https://github.com/symless/synergy-core/actions/workflows/sonarcloud-analysis.yml)
2024-07-11 14:26:38 +00:00
[](https://github.com/symless/synergy-core/actions/workflows/build-containers.yml)
2024-06-26 16:42:02 +00:00
2024-08-24 16:40:13 +00:00
[Synergy ](https://symless.com/synergy ) is a keyboard and mouse sharing app. Use the keyboard, mouse, or trackpad of one computer to control nearby computers, and work seamlessly between them.
2024-08-01 15:35:10 +00:00
2024-08-24 16:40:13 +00:00
This project contains the source code for _Synergy 1 Community Edition_ which is actively maintained, free to use, and does not require a license or serial key.
2024-08-11 00:22:50 +00:00
2024-08-30 14:53:25 +00:00
**Wayland support:** Wayland is supported (GNOME 46 is required).
2024-08-11 00:59:23 +00:00

2024-07-30 19:48:29 +00:00
2024-08-11 00:22:50 +00:00
To use the community edition, install the `synergy` package with your favorite package manager or build it yourself using the Developer Quick Start instructions below.
Join us on [Discord ](https://discord.com/invite/xBFv6j7 ) or [Slack ](https://synergy-app.slack.com/join/shared_invite/zt-d8if26fr-6x~TSTz4skGmTnFP5IPaww#/shared-invite/email ) in the `#open-source` channel.
2019-04-26 16:02:45 +00:00
2024-08-24 16:40:13 +00:00
* [Read the wiki ](https://github.com/symless/synergy/wiki )
* [Raise an issue ](https://github.com/symless/synergy/issues )
* [Start a discussion ](https://github.com/symless/synergy/discussions )
2019-04-26 16:02:45 +00:00
2024-07-30 19:48:29 +00:00
## Developer Quick Start
2019-04-26 16:02:45 +00:00
2024-08-11 01:09:06 +00:00
How to build Synergy 1 Community Edition. Check the [Developer Guide ](https://github.com/symless/synergy-core/wiki/Developer-Guide ) wiki page if you have problems.
2019-04-26 16:02:45 +00:00
2024-08-23 12:11:12 +00:00
**1. Dependencies:**
2024-08-23 11:47:40 +00:00
*Windows:*
2024-06-14 15:32:47 +00:00
```
python scripts/install_deps.py
```
2019-04-26 16:02:45 +00:00
2024-08-23 11:47:40 +00:00
*macOS/Linux:*
```
./scripts/install_deps.py
```
2024-08-23 12:11:12 +00:00
**2. Configure:**
2024-06-14 15:32:47 +00:00
*Windows:*
```
cmake -B build --preset=windows-release
```
*macOS:*
```
cmake -B build --preset=macos-release
```
*Linux:*
```
cmake -B build --preset=linux-release
```
2021-02-12 11:56:11 +00:00
2024-08-23 12:11:12 +00:00
**3. Build:**
2024-06-14 15:32:47 +00:00
```
2024-07-02 10:23:56 +00:00
cmake --build build -j8
2024-06-14 15:32:47 +00:00
```
2022-05-03 09:16:48 +00:00
2024-08-23 12:11:12 +00:00
**4. Test:**
2024-06-14 15:32:47 +00:00
```
./build/bin/unittests
```
2024-08-04 19:04:40 +00:00
## Packages
2024-08-23 12:11:12 +00:00
Synergy 1 Community Edition is packaged by the community (status shown below). Package maintainers can use `scripts/package.py` to build packages.
2024-08-04 19:04:40 +00:00
2024-08-24 16:51:16 +00:00
Synergy 2 is no longer in development and we recommend that package maintainers do not provide it.
2024-08-04 19:04:40 +00:00
2024-08-24 16:51:16 +00:00
Synergy 3 and Synergy 1 (licensed) are available to download from the [official packages ](https://symless.com/synergy/download ).
2024-08-12 16:23:06 +00:00
2024-08-24 16:51:16 +00:00
**Community edition:**
*Windows:*
2024-08-12 16:23:06 +00:00
```
choco install synergy
```
2024-08-24 16:51:16 +00:00
*macOS:*
2024-08-12 16:23:06 +00:00
```
brew install synergy
```
2024-08-24 16:51:16 +00:00
*Debian, Ubuntu, etc:*
2024-08-12 16:23:06 +00:00
```
sudo apt install synergy
```
2024-08-24 16:51:16 +00:00
*Fedora, Red Hat, etc:*
2024-08-12 16:23:06 +00:00
```
sudo dnf install synergy
```
2024-08-24 16:51:16 +00:00
*Arch, Manjaro, etc:*
2024-08-12 16:23:06 +00:00
```
2024-08-30 14:53:25 +00:00
sudo pacman -S synergy
2024-08-12 16:23:06 +00:00
```
2024-08-04 19:26:09 +00:00
2024-08-24 16:51:16 +00:00
*Repology:*
2024-08-04 19:04:40 +00:00
[](https://repology.org/project/synergy/versions)