littledivy / Autopilot Deno

Cross-platform desktop automation framework for Deno.

Features

• [x] Keyboard

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

• [x] Mouse

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

• [x] Screen

  • [x] Capture screen using .screenshot
  • [x] Get screen size using .screenSize
  • [x] Check if point out of bounds using .pointVisible
  • [x] Get number of pixels in a point using .screenScale

• [x] Notifications

  • [x] Native popup using .alert
  • [x] Notifications using .notify

• [x] Monitors

  • [x] Get the number of monitors using .getMonitors

• [x] Window management (only for linux)

  • [x] Get window title using .getWindow
  • [x] Transform windows size using .transformByIndex

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

Running your Deno script with AutoPilot requires some flags

deno run --unstable -A file.ts

NOTE: Prebuilt binaries are automatically downloaded the first time you import Autopilot in your project and are cached.

import AutoPilot from 'https://deno.land/x/[email protected]/mod.ts';

// create a new AutoPilot instance.
var pilot = new AutoPilot();

// type a string
await pilot.type("Yay! This works");

// alert something
await pilot.alert("This is a alert");

// get screen size
await pilot.screenSize();

// move mouse
await pilot.moveMouse(200, 400);

// take a full-screen screenshot
await pilot.screenshot("screenshot.png");

Env variables

• CACHE: Set if you want to update the release from Github.
• DEV: Set if you want t use the development debug builds.

Development

• Requires rust and cargo.
• Requires velociraptor

Clone this repo and run cargo build to produce a development build.

Commands

• Run tests: vr test
• Run and produce benchmarks: vr bench
• Format code fmt: vr fmt
• Create development build: vr build

Contributing

Contributing code and ideas to AutoPilot is really easy! Create an issue or PR. :)

License

See MIT License. All rights reserved. Divy Srivastava 2020.