Mac Use

Overlord is an AI management project that controls macOS through the local computer, providing direct system control and support for multiple LLM providers.

Operating system automation Artificial intelligence chatbots #macOS control #AI management #Screen interaction #File editing .Python

rating : 2 points

downloads : 8.2K

update time : 2025-04-28

Open Site

What is Overlord?

Overlord is an advanced AI control system that enables artificial intelligence to directly interact with your macOS computer. It provides tools for screen capture, mouse/keyboard control, and file system access, allowing AI agents to perform tasks just like a human user would.

How does Overlord work?

Overlord connects AI models (like Anthropic Claude) to your macOS system through native commands. It captures screen information, processes it through AI models, and then executes actions using system utilities.

Use Cases

Automate repetitive tasks, AI-assisted workflow automation, accessibility tools for disabled users, automated testing of GUI applications, and AI research in human-computer interaction.

Key Features

Native macOS GUI Interaction

Direct control over macOS interface elements without requiring Docker or virtual machines

Smart Screen Capture

Automatic screen capture with resolution scaling optimized for AI processing

Precise Input Control

Keyboard and mouse control through cliclick utility with millisecond precision

Multiple AI Model Support

Works with Anthropic, AWS Bedrock, and Google Vertex AI models

File System Access

Read and edit files directly through the AI interface

Advantages

No complex setup required - works natively on macOS

Highly customizable through simple configuration

Supports multiple leading AI providers

Automatic resolution scaling optimizes performance

Limitations

Only available for macOS (Sonoma 15.7+)

Requires careful use due to system-level access

Higher resolutions may impact performance

Currently in beta - API may change

Getting Started

Install Dependencies

Ensure you have Homebrew installed, then install cliclick for mouse/keyboard control

Set Up Environment

Create and activate a Python virtual environment

Configure API Keys

Create a .env file with your Anthropic API key and preferred screen resolution

Launch the Interface

Start the Streamlit web interface to begin controlling your Mac with AI

Example Use Cases

Automated Data Entry

Have the AI fill out forms in your accounting software automatically

AI Assistant

Use voice commands to have the AI perform complex multi-step computer tasks

Frequently Asked Questions

Is Overlord safe to use?

What screen resolution works best?

Can I use other AI models besides Anthropic?

Why do I need cliclick?

Additional Resources

Anthropic API Documentation

Official documentation for the Anthropic API used by Overlord

Cliclick Utility

Information about the cliclick mouse/keyboard control utility

Overlord GitHub Repository

Source code and issue tracking for Overlord

🚀 Overlord —— Take Control of Your Mac Device

Overlord is an AI project based on local computers that can directly control the macOS system through native macOS commands and tools.

⚠️ Important Note

This project poses significant risks. Overlord can fully control your Mac. Please operate with caution.

✨ Features

Native macOS graphical interface interaction (no Docker required)
Take screenshots using native macOS commands
Control the keyboard and mouse via cliclick
Support multiple LLM providers (Anthropic, Bedrock, Vertex)
Interface based on Streamlit
Automatic screen resolution scaling
File system interaction and editing capabilities

📦 Prerequisites

macOS Sonoma 15.7 or higher
Python 3.12+
Homebrew (for installing additional dependencies)
cliclick (installed via brew install cliclick) — required for mouse and keyboard control

📦 Installation Guide

Clone the repository and navigate to the directory:

git clone https://github.com/hanzoai/overlord.git
cd overlord

Create and activate a virtual environment:

python3.12 -m venv venv
source venv/bin/activate

Run the setup script:

chmod +x setup.sh
./setup.sh

Install Python dependencies:

pip install -r requirements.txt

💻 Usage Examples

Set up the environment and Anthropic API key

Add the following content to the .env file:

API_PROVIDER=anthropic
ANTHROPIC_API_KEY=<key>
WIDTH=800
HEIGHT=600
DISPLAY_NUM=1

Set the screen resolution (it is recommended to be within the XGA/WXGA resolution range) and add the key obtained from the Anthropic console. 2. Start the Streamlit application:

streamlit run streamlit.py

The interface will be available at http://localhost:8501

Screen Resolution Considerations

We recommend using the following resolutions for optimal performance:

XGA: 1024x768 (4:3)
WXGA: 1280x800 (16:10)
FWXGA: 1366x768 (~16:9) Higher resolutions will be automatically scaled to these target resolutions to optimize model performance. You can set the resolution through environment variables:

export WIDTH=1024
export HEIGHT=768
streamlit run streamlit.py

⚠️ Important Note

The Beta API used in this reference implementation may change. Please refer to the API release notes for the latest information.