Skip to main content

​
Quick Install

The recommended way to install agent-desktop is via npm, which downloads a prebuilt binary automatically. 
npm install -g agent-desktop

​
Requirements

Platform support: macOS 13.0+ (Ventura or later)Windows and Linux support is planned for Phase 2.

​
For npm installation

  • Node.js 18 or later
  • macOS 13.0+

​
For building from source

  • Rust 1.78+
  • macOS 13.0+
  • Xcode Command Line Tools

​
Installation Methods

1

Install via npm (recommended)

Install globally to use agent-desktop from anywhere:
npm install -g agent-desktop
The postinstall script automatically downloads the correct prebuilt binary for your platform.
2

Run without installing (npx)

Use npx to run agent-desktop without global installation:
npx agent-desktop snapshot --app Finder -i
npx agent-desktop click @e3
Perfect for CI environments or one-off automation tasks.
3

Build from source

For development or custom builds:
# Clone the repository
git clone https://github.com/lahfir/agent-desktop
cd agent-desktop

# Build optimized release binary
cargo build --release

# Copy to your PATH
cp target/release/agent-desktop /usr/local/bin/
The release build is optimized to under 15MB with LTO and strip enabled.

​
Verify Installation

Check that agent-desktop is installed correctly: 
agent-desktop version
You should see version 0.1.11 or later.

​
Next Steps

macOS requires Accessibility permission before agent-desktop can interact with applications.See Permissions to grant the required permissions.
After installation:

Set up permissions

Grant macOS Accessibility permission

Quick Start

Learn the snapshot → act → snapshot workflow

Build docs developers (and LLMs) love

Get started for freeTalk to us