/autopilot-deno

:rocket: Cross-platform desktop automation module for Deno.

Primary LanguageRustMIT LicenseMIT

ci deno version nest badge

AutoPilot Deno - Cross-platform desktop automation framework for Deno.

Features

  • Keyboard

    • Type a string using .type
    • Tap a key using .tap
    • Toggle key using .toggleKey

  • Mouse

    • Simulate mouse movement using .moveMouse
    • Click using .click
    • Simulate a scroll using .scroll
    • Get mouse position using .mousePosition
    • Get mouse position pixel color .pixelColor

  • Screen

    • Capture screen using .screenshot
    • Get screen size using .screenSize
    • Get number of pixels in a point using .screenScale

  • Notifications

    • Native popup using .alert
    • Notifications using .notify

Documentation

Detailed documentation of the API is available at:

https://autopilot.mod.land

Requirements

Linux

sudo apt-get update
sudo apt-get install libdbus-1-dev x11-xserver-utils wmctrl libxtst-dev cmake libc-dev libx11-dev libxcb1-dev

Usage

deno run --unstable --allow-ffi example.ts
// example.ts
import AutoPilot from "https://deno.land/x/autopilot/mod.ts";

const pilot = new AutoPilot();

// type a string
await pilot.type("Yay! This works");
// get screen size
const screenSize = await pilot.screenSize();
// move mouse
await pilot.moveMouse(200, 400);
// take a screenshot
await pilot.screenshot("screenshot.png");
// ...and more stuff

License

MIT License.