iOS Client

import { createInstanceClient } from '@limrun/ios-client';

const client = await createInstanceClient({
  apiUrl: 'https://instance.limrun.com',
  token: 'your-token',
  logLevel: 'info'
});

console.log(client.deviceInfo);
// {
//   udid: 'ABC123-DEF456',
//   screenWidth: 390,
//   screenHeight: 844,
//   model: 'iPhone 14 Pro'
// }

const screenshot = await client.screenshot();
console.log(`Screenshot: ${screenshot.width}x${screenshot.height}`);
const imageData = Buffer.from(screenshot.base64, 'base64');

await client.tap(195, 422);

// Tap at 50% of a 1080x1920 screenshot
await client.tapWithScreenSize(540, 960, 1080, 1920);

// Scroll down 300 pixels from center
await client.scroll('down', 300);

// Scroll with custom starting point and momentum
await client.scroll('up', 500, {
  coordinate: [195, 400],
  momentum: 0.8 // Fast scroll with inertia
});

await client.setOrientation('Landscape');

const tree = await client.elementTree();
console.log(JSON.parse(tree));

// Get element at specific point
const elementAtPoint = await client.elementTree({ x: 100, y: 200 });

// Tap by accessibility identifier
await client.tapElement({ accessibilityId: 'login-button' });

// Tap by label
await client.tapElement({ label: 'Sign In' });

// Tap by element type and label contains
await client.tapElement({
  elementType: 'Button',
  labelContains: 'continue'
});

await client.incrementElement({ accessibilityId: 'volume-slider' });

await client.decrementElement({ accessibilityId: 'volume-slider' });

await client.setElementValue('[email protected]', {
  accessibilityId: 'email-field'
});

await client.typeText('Hello, World!');

// Type and press Enter
await client.typeText('search query', true);

// Press Enter
await client.pressKey('enter');

// Press Command+S
await client.pressKey('s', ['command']);

// Press Command+Shift+F
await client.pressKey('f', ['command', 'shift']);

await client.toggleKeyboard();

// Launch and bring to foreground if already running
await client.launchApp('com.example.app');

// Terminate and relaunch if already running
await client.launchApp('com.example.app', 'RelaunchIfRunning');

await client.terminateApp('com.example.app');

// Basic installation
const result = await client.installApp('https://example.com/app.ipa');
console.log(`Installed: ${result.bundleId}`);

// Install with caching and auto-launch
const result2 = await client.installApp('https://example.com/app.ipa', {
  md5: 'abc123...', // Skip download if cached version matches
  launchMode: 'RelaunchIfRunning'
});

const apps = await client.listApps();
for (const app of apps) {
  console.log(`${app.name} (${app.bundleId}) - ${app.installType}`);
}

// Sync and install
const result = await client.syncApp('/path/to/MyApp.app', {
  install: true,
  launchMode: 'RelaunchIfRunning'
});

// Watch mode for development
const result2 = await client.syncApp('/path/to/MyApp.app', {
  install: true,
  watch: true,
  maxPatchBytes: 1024 * 1024 // 1MB patch limit
});

// Open web URL
await client.openUrl('https://example.com');

// Open deep link
await client.openUrl('myapp://profile/123');

const logs = await client.appLogTail('com.example.app', 100);
console.log(logs);

const stream = client.streamAppLog('com.example.app');

stream.on('line', (line) => {
  console.log('[APP]', line);
});

stream.on('error', (error) => {
  console.error('Stream error:', error);
});

// Stop streaming when done
stream.stop();

const stream = client.streamSyslog();

stream.on('line', (line) => {
  console.log('[SYS]', line);
});

// Stop when done
stream.stop();

const execution = client.simctl(['boot']);

// Listen to raw data
execution.on('stdout', (data) => {
  console.log('stdout:', data.toString());
});

// Or listen line-by-line
execution.on('line-stdout', (line) => {
  console.log('Line:', line);
});

execution.on('line-stderr', (line) => {
  console.error('Error:', line);
});

execution.on('exit', (code) => {
  console.log('Process exited with code:', code);
});

// Or wait for completion
const result = await execution.wait();
console.log('Exit code:', result.code);
console.log('Full stdout:', result.stdout);

// Disconnect when command finishes
const execution2 = client.simctl(['status'], { disconnectOnExit: true });

// Get the SDK version for iphonesimulator
const result = await client.xcrun(['--sdk', 'iphonesimulator', '--show-sdk-version']);
console.log('SDK version:', result.stdout.trim());

// Get the SDK build version (default SDK)
const buildResult = await client.xcrun(['--show-sdk-build-version']);
console.log('Build version:', buildResult.stdout.trim());

const result = await client.xcodebuild(['-version']);
console.log('Xcode version:', result.stdout);
// Output: Xcode 16.0
//         Build version 16A242d

const remotePath = await client.cp('test-data.json', '/local/path/test-data.json');
console.log('File available at:', remotePath);
// Use remotePath in simctl commands

const files = await client.lsof();
for (const file of files) {
  console.log(file.path);
}

client.disconnect();

const state = client.getConnectionState();
console.log(state); // 'connecting' | 'connected' | 'disconnected' | 'reconnecting'

const unsubscribe = client.onConnectionStateChange((state) => {
  console.log('Connection state changed:', state);
});

// Later, to unregister:
unsubscribe();

import { createInstanceClient } from '@limrun/ios-client';

async function automateApp() {
  // Create the client
  const client = await createInstanceClient({
    apiUrl: 'https://instance.limrun.com',
    token: 'your-token'
  });

  console.log('Connected to:', client.deviceInfo.model);

  // Install and launch app
  const { bundleId } = await client.installApp('https://example.com/app.ipa', {
    launchMode: 'RelaunchIfRunning'
  });

  console.log('App installed:', bundleId);

  // Wait for app to load
  await new Promise(resolve => setTimeout(resolve, 2000));

  // Take screenshot
  const screenshot = await client.screenshot();
  console.log(`Screenshot: ${screenshot.width}x${screenshot.height}`);

  // Interact with elements
  await client.tapElement({ accessibilityId: 'username-field' });
  await client.typeText('[email protected]');

  await client.tapElement({ accessibilityId: 'password-field' });
  await client.typeText('password123', true); // Press Enter after typing

  // Or tap by label
  await client.tapElement({ label: 'Sign In' });

  // Stream logs
  const logStream = client.streamAppLog(bundleId);
  logStream.on('line', (line) => {
    console.log('[LOG]', line);
  });

  // Wait for some activity
  await new Promise(resolve => setTimeout(resolve, 5000));

  // Cleanup
  logStream.stop();
  client.disconnect();
}

automateApp().catch(console.error);