Documentation

Learn how to use TapKit to control iPhones programmatically.

Installation

Install TapKit using pip. Python 3.9 or higher is required.

Requirements

• Python 3.9+
• macOS (for local development)
• TapKit Mac app running
• iPhone connected via USB or Wi-Fi

Quickstart

Here's a simple example to get you started. This connects to your iPhone, opens Settings, and navigates to the About screen.

Key concepts

Natural language selectors: Instead of coordinates, describe what you want to tap: "the Settings app", "the search button", etc.
Automatic waiting: TapKit waits for elements to appear before interacting with them.
Screenshots: Get screenshots at any point to see what's on screen.

Gestures

TapKit supports all the gestures you'd use on an iPhone.

Device Control

Control device-level functions like home button, volume, and orientation.

Agent Tools

Use TapKit with AI agents. We provide tool definitions for popular frameworks.

Supported frameworks

• Anthropic Claude (claude-sonnet, claude-opus)
• OpenAI GPT-4
• LangChain
• Custom tool definitions

Ready to get started?

Get your API key and start building.