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 fully before installing!
Python modules (common):
GTK frontend only:
- GObject Introspection
QT frontend only:
- 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.)
Install via pip
pip will automatically resolve and install dependencies, but dbus-python requires the dbus headers be present on your system. These are usually installed through your package manager, and usually are named dbus-devel or libdbus-dev or similar.
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.
There is a repository available for Ubuntu 18.04 LTS (and compatible derivatives, such as Kubuntu):
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 distros using files under
debian/ . Check out the Packaging wiki page for details.
Available in the AUR. Unfortunately, Arch has removed the kdebindings-python package, so only the GTK frontend is usable for now.
Available via layman.
layman -a y2kbadbug emerge --sync emerge -av autokey
Avaiable from Fedora 27 onwards.
sudo dnf install autokey-gtk # or for kde sudo dnf install autokey-kde
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 Pull Requests
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.