README

Deskflow is a free and open source keyboard and mouse sharing app.
Use the keyboard, mouse, or trackpad of one computer to control nearby computers,
and work seamlessly between them.
It's like a software KVM (but without the video).
TLS encryption is enabled by default. Wayland is supported. Clipboard sharing is supported.

 [!TIP]

 Chat with us

 - Main discussion on Matrix: deskflow:matrix.org (Matrix clients)
 - Discussion also happens on IRC: deskflow or deskflow-dev on Libera Chat
 - Start a new discussion on our GitHub project.

 Download

            

 [!NOTE]
 On Windows, you will need to install the
 Microsoft Visual C++ Redistributable.  
 Download latest: vc_redist.x64.exe vc_redist.arm64.exe

 [!TIP]
 For macOS users, the easiest way to install and stay up to date is to use Homebrew with our homebrew-tap.
 macOS reports unsigned apps as damaged. This occurs because we do not use an Apple certificate for notarization. Clear the quarantine attribute to run the app: xattr -c Deskflow.app

To use Deskflow, download one of our packages, install deskflow (from your package repository), or build it from source.

 Stats















 Contribute



There are many ways to contribute to the Deskflow project.

We're a friendly, active, and welcoming community focused on building a great app.

Read our Contributing page to get started.

For instructions on building Deskflow, use the wiki page: Building

 Operating Systems

We support all major operating systems, including Windows, macOS, Linux, and Unix-like BSD-derived.

Windows 10 v1809 or higher is required.

macOS 13 or higher is required to use our CI builds for Apple Silicon machines. macOS 12 or higher is required for Intel macs or local builds.

Linux requires libei 1.3+ and libportal 0.8+ for the server/client. Additionally, Qt 6.7+ is required for the GUI.
Linux users with systems not meeting these requirements should use flatpak in place of a native package.

We officially support FreeBSD, and would also like to support: OpenBSD, NetBSD, DragonFly, Solaris.

 Repology

Repology monitors a huge number of package repositories and other sources comparing package
versions across them and gathering other information.



 Installing on macOS

When you install Deskflow on macOS, you need to allow accessibility access (Privacy & Security) to both the Deskflow app and the deskflow process.

If using Sequoia, you may also need to allow Deskflow under Local Network‍ settings (Privacy & Security).
When prompted by the OS, go to the settings and enable the access.

If you are upgrading and you already have Deskflow or deskflow
on the allowed list you will need to manually remove them before accessibility access can be granted to the new version.

macOS users who download directly from releases may need to run xattr -c /Applications/Deskflow.app after copying the app to the Applications dir.

It is recommended to install Deskflow using H