Browse documentation

Start

Installation

Install the CLI, harness, and TypeScript SDK.

Packages

PackagePurposeRuntime
phone-useCLI, MCP, agent loop, maps, skills, viewer, tracesBun 1.3+
@phone-use/sdkTyped lifecycle and observe/act APINode 22+ or Bun

Install the CLI

bashphone-use
curl -fsSL https://phoneuse.dev/install | bash
phone-use --help

The CLI runs on Bun 1.3 or newer. The script installs Bun if it is missing, then installs the CLI with bun add --global phone-use. Run it again to update.

With Bun already installed, you can use a package manager instead: npm install -g phone-use, bun add --global phone-use, or per project bun add phone-use and bunx phone-use.

Install the SDK

bashphone-use
npm install @phone-use/sdk

Choose a device

A cloud phone needs no device flag: attach it with eval "$(phone-use env <id>)". For a local device, choose one when you start the MCP server.

bashphone-use
phone-use mcp --device launch
phone-use mcp --device connect
phone-use mcp --device <simulator-udid>
phone-use mcp --device android