Skip to main content
The Limrun SDK includes several complete, runnable examples that demonstrate different use cases and integrations. Each example includes full source code and detailed instructions.

​
Available Examples

Appium iOS Automation

Automate iOS simulators using Appium and WebDriverAgent from any platform, including Linux CI runners.

Playwright Android

Automate Android Chrome and WebViews using Playwright with low-latency CDP connections.

Full-Stack Integration

Complete React + Express application showing backend instance management and frontend streaming.

iOS Hot Reload

Continuously sync iOS app changes with efficient binary patching and live log streaming.

Asset Upload & Installation

Upload apps to Limrun Asset Storage and install them on instances with MD5 deduplication.

ADB Tunnel

Connect to Android instances via ADB tunnel for debugging with Android Studio and standard tools.

iOS WebSocket API Demo

Comprehensive demonstration of all iOS client methods including screenshots, taps, and simctl commands.

Xcode Sandbox

Build iOS apps in the cloud with automatic code sync and hot reload workflow.

​
Running the Examples

All examples are located in the examples/ directory of the SDK repository.

​
Prerequisites

  1. Get your API key from Limrun Console Settings
  2. Set environment variable: 
    export LIM_API_KEY="lim_..."
  3. Install dependencies for the specific example: 
    cd examples/<example-name>
yarn install

​
General Structure

Each example follows a consistent structure:
  • index.ts - Main example code
  • package.json - Dependencies and scripts
  • README.md - Specific instructions and background
  • tsconfig.json - TypeScript configuration

​
Running an Example

Most examples can be run with: 
yarn run start
Some examples may require additional setup (like installing Appium or building an iOS app). Check the specific example documentation for details.

​
Example Categories

​
Automation Testing

  • Appium iOS - Native app and Safari browser automation
  • Playwright Android - Chrome and WebView automation with CDP
  • iOS WebSocket API Demo - Complete iOS client API demonstration

​
Development Workflows

  • iOS Hot Reload - Efficient app development with live updates
  • Xcode Sandbox - Cloud-based iOS development with automatic sync
  • Full-Stack App - Embedding instances in your application

​
Asset Management

  • Asset Upload - Upload and install apps with deduplication

​
Debugging & Tools

  • ADB Tunnel - Connect Android Studio and standard Android tools

​
Next Steps

API Reference

Explore the complete API documentation

Guides

Learn core concepts and best practices

Build docs developers (and LLMs) love

Get started for freeTalk to us