Important: This is an X11 application, and as such will not function 100% on distributions that default to using Wayland instead of Xorg.
Please remove previous installations of both AutoKey and AutoKey-py3 fully before installing!
The dbus module requires manual installation, preferably using your distribution package manager. Due to odd detection issues with pip3 and this particular package, it is not defined as a dependency. Without having dbus-python (PyPi link) installed, AutoKey won’t start.
- GObject Introspection
- SVG module, if not already bundled
- QScintilla2 module, if not already bundled
pyrcc5command line tool (Optional installation time dependency, only used when installing or updating from the git source tree using setup.py. If not present, a fallback that causes a slightly slower application start will be used.)
pip3 will automatically resolve and install dependencies, but dbus-python requires manual installation.
pip3 install autokey # or, if you want the latest from this repository, pip3 install --user git+https://github.com/autokey/autokey
The "--user" option for pip may be added to install for the current user only. To install system-wide, run pip3 as the root user.
There is a repository available for Ubuntu 18.04 LTS (and compatible derivatives, such as Kubuntu). If your Debian based system is not supported by the PPA or the PPA is not up to date, you can build your own packages (see below) or use the packages attached to the GitHub Releases page https://github.com/autokey/autokey/releases/.
sudo add-apt-repository ppa:sporkwitch/autokey sudo apt update sudo apt install autokey-gtk # Or alternatively, to install the Qt5 based GUI: sudo apt install autokey-qt
Distro package not provided? Create your own package for Debian-based distribution using files under
debian/ . Check out the Packaging wiki page for details.
Up to date packages are available in the AUR.
Avaiable from Fedora 27 onwards.
sudo dnf install autokey-gtk # or for kde sudo dnf install autokey-kde
AutoKey can also be used directly from the cloned repository. This is useful, e.g., for trying out a new version without removing a current installation.
- Start the Autokey daemon
cd lib python3 -m autokey.gtkui # or for KDE python3 -m autokey.qtui
- Start the Autokey UI (if desired) by appending the --configure or -c command line switch to the end of the command.
The commands accept CLI switches just like the regular installation, so
python3 -m autokey.qtui -lc works as expected.
We'd appreciate it if you take a look at Problem reporting guide before posting. By providing as much information as you can, you'll have a much better chance of getting a good answer in less time.
Bug reports and PRs are welcome. Please use the GitHub Issue Tracker for bug reports. When reporting a suspected bug, please test against latest
git HEAD and make sure to include as much information as possible to expedite troubleshooting and resolution. For example,
- required: How to reproduce the issue you are experiencing
- Python tracebacks, if any
- Verbose logging information obtained by starting the frontend (
autokey-qt) from terminal with the
GNU GPL v3. See the LICENSE file alongside this README for a plain text copy of the license text.