22 releases

0.2.1 May 16, 2024
0.2.0-rc2 Nov 18, 2023
0.1.2 Apr 3, 2023
0.1.1 Mar 30, 2023
0.0.7 Feb 5, 2017

#12 in Hardware support

Download history 1019/week @ 2024-03-27 1237/week @ 2024-04-03 1363/week @ 2024-04-10 1344/week @ 2024-04-17 1330/week @ 2024-04-24 1372/week @ 2024-05-01 1187/week @ 2024-05-08 1393/week @ 2024-05-15 1233/week @ 2024-05-22 1218/week @ 2024-05-29 1072/week @ 2024-06-05 1215/week @ 2024-06-12 1427/week @ 2024-06-19 1239/week @ 2024-06-26 866/week @ 2024-07-03 888/week @ 2024-07-10

4,668 downloads per month
Used in 41 crates (34 directly)

MIT license

250KB
5.5K SLoC

Build status Docs Dependency status

Rust version Crates.io

enigo

Cross platform input simulation in Rust!

  • Serialize/Deserialize
  • Linux (X11) mouse
  • Linux (X11) text
  • Linux (Wayland) mouse
  • Linux (Wayland) text
  • Linux (libei) mouse
  • Linux (libei) text
  • MacOS mouse
  • MacOS text
  • Windows mouse
  • Windows text

Enigo also works on *BSDs if they use X11 or Wayland. I don't have a machine to test it and there are no Github Action runners for it, so the BSD support is not explicitly listed.

let mut enigo = Enigo::new(&Settings::default()).unwrap();

enigo.move_mouse(500, 200, Abs).unwrap();
enigo.button(Button::Left, Click).unwrap();
enigo.text("Hello World! here is a lot of text  ❤️").unwrap();

For more, look at the (examples).

Features

By default, enigo currently works on Windows, macOS and Linux (X11). If you want to be able to serialize and deserialize commands for enigo (example), you need to activate the serde feature.

There are multiple ways how to simulate input on Linux and not all systems support everything. Enigo can also use wayland protocols and libei to simulate input but there are currently some bugs with it. That is why they are hidden behind feature flags.

If you do not want your users to have to install any runtime dependencies on Linux when using X11, you can try the experimental x11rb feature.

Runtime dependencies

Linux users may have to install libxdo-dev if they are using X11. For example, on Debian-based distros:

apt-get install libxdo-dev

On Arch:

pacman -S xdotool

On Fedora:

dnf install libX11-devel libxdo-devel

On Gentoo:

emerge -a xdotool

Migrating from a previous version

Please have a look at our changelog to find out what you have to do, if you used a previous version.

Permissions

Some platforms have security measures in place to prevent programs from entering keys or controlling the mouse. Have a look at the permissions documentation to see what you need to do to allow it.

Dependencies

~0–46MB
~733K SLoC