SwiftAutoGUI: Library for manipulating macOS with Swift

Introduction

I developed library for manipulating macOS with Swift. In this article, I will explain usage.

If you think it's good, star me!

NakaokaRei / SwiftAutoGUI

Used to programmatically control the mouse & keyboard.

SwiftAutoGUI

Used to programmatically control the mouse & keyboard A library for manipulating macOS with Swift.

This repository is implemented with reference to pyautogui.

Installation

SwiftAutoGUI is available through Swift Package Manager.

in Package.swift add the following:

dependencies: [
    // Dependencies declare other packages that this package depends on.
    .package(url: "https://github.com/NakaokaRei/SwiftAutoGUI", branch: "master")
],
targets: [
    .target(
        name: "MyProject",
        dependencies: [..., "SwiftAutoGUI"]
    )
    ...
]

Example Usage

Keyboard and Mouse Control

See Keycode.swift for supported keys. If it is not a US keyboard, This may not work properly.

import SwiftAutoGUI
// Send ctrl + ←
SwiftAutoGUI.sendKeyShortcut([.control, .leftArrow])

// Send sound up
SwiftAutoGUI.keyDown(.soundUp)
SwiftAutoGUI.keyUp(.soundUp)

// Move mouse by dx, dy

…

View on GitHub

Installation

SwiftAutoGUI is available through Swift Package Manager.　

in Package.swift add the following:

dependencies: [
    // Dependencies declare other packages that this package depends on.
    .package(url: "https://github.com/NakaokaRei/SwiftAutoGUI", branch: "master")
],
targets: [
    .target(
        name: "MyProject",
        dependencies: [..., "SwiftAutoGUI"]
    )
    ...
]

Example Usage

Keyboard

By calling a method of the SwiftAutoGUI class as shown below, you can send key input commands to macOS. Supported keys are written in Keycode.swift.

As shown in the sample below, you can also input shortcuts, such as moving the virtual desktop by sending the command ctrl + ←.

import SwiftAutoGUI

// Send ctrl + ←
SwiftAutoGUI.sendKeyShortcut([.control, .leftArrow])

// Send sound up
SwiftAutoGUI.keyDown(.soundUp)
SwiftAutoGUI.keyUp(.soundUp)

Mouse

Similarly, mouse operations can generate basic commands such as mouse movement, clicking, and scrolling by invoking methods of the SwiftAutoGUI class.

import SwiftAutoGUI

// Move mouse by dx, dy from the current location
SwiftAutoGUI.moveMouse(dx: 10, dy: 10)

// Click where the mouse is located
SwiftAutoGUI.leftClick()

// Scroll
SwiftAutoGUI.vscroll(clicks: 10) // up
SwiftAutoGUI.vscroll(clicks: -10) // down
SwiftAutoGUI.hscroll(clicks: 10) // left
SwiftAutoGUI.hscroll(clicks: -10) // right

Conclusion

In the future, we would like to add JIS keyboard support, support for other operating systems, and events.