xc-mcp/dist/tools/simctl/erase.d.ts

MCP server that wraps Xcode command-line tools for iOS/macOS development workflows

/**
 * Reset iOS simulator devices to factory settings
 *
 * **What it does:**
 * Resets a simulator to clean factory state without deleting the device itself. All apps
 * and data are removed, but the simulator persists and can be immediately reused.
 *
 * **Why you'd use it:**
 * - Clean state for fresh app installation testing without recreating simulators
 * - Data removal clears all apps, preferences, and user data
 * - Testing workflows benefit from repeatable clean states
 * - Device preserved means simulator remains available for immediate reuse
 *
 * **Parameters:**
 * - `deviceId` (string): Device UDID to erase (from simctl-list)
 * - `force` (boolean, optional): Force erase even if device is booted (default: false)
 *
 * **Returns:**
 * Erase status with device information and confirmation that device persists
 *
 * **Example:**
 * ```typescript
 * // Erase simulator to clean state
 * await simctlEraseTool({ deviceId: 'ABC-123-DEF' })
 *
 * // Force erase booted device
 * await simctlEraseTool({ deviceId: 'ABC-123-DEF', force: true })
 * ```
 *
 * **Full documentation:** See simctl/erase.md for clean state testing patterns
 *
 * @param args Erase configuration (requires deviceId)
 * @returns Tool result with erase status and guidance
 * @throws McpError for invalid device ID or erase failure
 */
export declare function simctlEraseTool(args: any): Promise<{
    content: {
        type: "text";
        text: string;
    }[];
    isError: boolean;
}>;
export declare const SIMCTL_ERASE_DOCS = "\n# simctl-erase\n\nReset iOS simulator devices to factory settings.\n\n## Overview\n\nResets a simulator to clean factory state without deleting the device itself. All apps and data are removed, but the simulator persists and can be immediately reused. Useful for clean state testing and fresh app installation workflows.\n\n## Parameters\n\n### Required\n- **deviceId** (string): Device UDID to erase (from simctl-list)\n\n### Optional\n- **force** (boolean, default: false): Force erase even if device is booted\n\n## Returns\n\nErase status with device information, confirmation that device persists, wasBooted flag indicating if device was running during erase, success indicator, and guidance for next steps.\n\n## Examples\n\n### Erase simulator to clean state\n```typescript\nawait simctlEraseTool({ deviceId: 'ABC-123-DEF' });\n```\n\n### Force erase booted device\n```typescript\nawait simctlEraseTool({\n  deviceId: 'ABC-123-DEF',\n  force: true\n});\n```\n\n## Related Tools\n\n- simctl-list: Find device UDID to erase\n- simctl-shutdown: Shutdown device before erase (if not using force)\n- simctl-boot: Boot device after erase to continue testing\n\n## Notes\n\n- Device persists after erase - only data is removed\n- All apps, preferences, and user data are deleted\n- Device returns to factory settings\n- Use force: true to erase booted device (otherwise must shutdown first)\n- Perfect for repeatable clean state testing\n- Faster than delete + create for reset workflows\n";
//# sourceMappingURL=erase.d.ts.map