ios-bridge-cli 1.0.5

Desktop streaming client for iOS Bridge simulator sessions with Electron app integration

iOS Bridge CLI

A Python-based command-line tool for streaming and controlling iOS simulator sessions from your desktop, similar to how scrcpy works for Android devices.

Features

• 🖥️ Desktop streaming of iOS simulator sessions
• 🎮 Touch and keyboard input control
• 📱 Device controls (Home, Screenshot, Device Info)
• 🔌 WebSocket-based real-time streaming
• 🚀 Easy installation via pip
• 💻 Cross-platform Electron-based UI
• 🌐 Remote server support (Windows/Linux/macOS)
• 🖥️ Local server management (macOS only)

Installation

pip install ios-bridge-cli

Platform Support

macOS (Full Functionality)

• ✅ Local server management
• ✅ Remote client connections
• ✅ Desktop streaming
• ✅ All CLI commands

Windows/Linux (Remote Client Only)

• ❌ Local server (requires macOS + Xcode)
• ✅ Remote client connections
• ✅ Desktop streaming
• ✅ Session management commands

Quick Start

Cross-Platform Setup (Most Common)

Run iOS simulators on Mac, stream to Windows/Linux:

Mac (Server):

ios-bridge start-server --host 0.0.0.0 --port 8000

Windows/Linux (Client):

ios-bridge connect http://[MAC-IP]:8000 --save
ios-bridge list
ios-bridge stream <session-id>

📖 Complete Cross-Platform Setup Guide

Remote Server Connection

# Connect to your deployed iOS Bridge server
ios-bridge connect https://ios-bridge.yourcompany.com --save

# Test connection
ios-bridge server-status

# Use all commands with remote server
ios-bridge devices
ios-bridge create "iPhone 14 Pro" "18.2" --wait
ios-bridge stream <session_id>

Local Server Management (macOS Only)

# Start the iOS Bridge server (auto-detects server location)
ios-bridge start-server

# Start server in background
ios-bridge start-server --background

# Start server on custom port
ios-bridge start-server --port 9000

# Check server status
ios-bridge server-status

# Stop the server
ios-bridge kill-server

# Force stop all server processes
ios-bridge kill-server --force --all

Session Management

# List available device types and iOS versions
ios-bridge devices

# Create a new iOS simulator session
ios-bridge create "iPhone 14 Pro" "16.0" --wait

# List active sessions
ios-bridge list

# Get session information
ios-bridge info <session_id>

# Terminate a session
ios-bridge terminate <session_id>

Streaming and Control

# Stream an existing session in desktop window
ios-bridge stream <session_id>

# Stream with quality settings
ios-bridge stream <session_id> --quality ultra --fullscreen

# Take screenshot
ios-bridge screenshot <session_id> --output screenshot.png

Note: The --server option is still available if you need to connect to a remote server, but it defaults to http://localhost:8000 when using the local server commands.

Controls

• Mouse: Click and drag for touch input
• Keyboard: Type directly into the device
• Ctrl+C: Close streaming window and exit
• F1: Home button
• F2: Take screenshot
• F3: Show device info

Requirements

• macOS (for iOS Bridge server)
• Python 3.8+
• Running iOS Bridge server instance

Architecture

┌─────────────────┐    HTTP/WS     ┌─────────────────┐    IPC    ┌─────────────────┐
│   Python CLI    │ ←─────────────→ │  iOS Bridge     │           │  Electron App   │
│                 │                 │    Server       │           │                 │
│ • CLI parsing   │                 │                 │           │ • Video render  │
│ • API client    │                 │ • Session mgmt  │ ←────────→ │ • Touch input   │
│ • Process mgmt  │                 │ • WebSockets    │           │ • UI controls   │
└─────────────────┘                 └─────────────────┘           └─────────────────┘

Development

Desktop App Development

The iOS Bridge desktop app (Electron) supports development mode with live reloading and debugging capabilities.

Quick Start:

cd ios-bridge-cli/ios_bridge_cli/electron_app
npm install
npm run dev

Development with Session Override:

# Override session ID from command line
npm run dev -- --session-id=your-session-id

# Multiple overrides
npm run dev -- --session-id=abc123 --server-host=192.168.0.101 --quality=ultra --fullscreen

Available Override Options:

• --session-id - Override session ID
• --server-host - Override server hostname
• --server-port - Override server port
• --quality - Override streaming quality (low/medium/high/ultra)
• --fullscreen - Enable fullscreen mode
• --always-on-top - Keep window always on top

Development Features:

• 🔄 Live reloading when files change
• 🛠️ Chrome DevTools for debugging (Ctrl+Shift+I)
• 📝 Enhanced logging and debugging
• 🎯 Command line configuration overrides
• 🚀 WebRTC and WebSocket testing

For detailed development documentation, see: DEVELOPMENT.md

CLI Development

Setting up CLI for development:

# Clone and install in development mode
git clone <repo-url>
cd ios-bridge-cli
pip install -e .

Testing CLI changes:

# Test CLI commands
ios-bridge list
ios-bridge stream <session-id>

# Test with different servers
ios-bridge --server http://remote-server:8000 list

License

MIT License