mirroir-mcp 0.18.0 → 0.20.0

package/README.md

@@ -7,7 +7,6 @@ This npm package downloads the pre-built macOS binary from [GitHub releases](htt
 ## Requirements
 
 - macOS 15+ with iPhone Mirroring
-- [Karabiner-Elements](https://karabiner-elements.pqrs.org/) installed and activated
 - iPhone connected via iPhone Mirroring
 
 ## Install
@@ -28,7 +27,7 @@ Then add to your MCP client config:
 }
 ```
 
-See the [full documentation](https://github.com/jfarcand/mirroir-mcp) for setup instructions including the Karabiner helper daemon.
+See the [full documentation](https://github.com/jfarcand/mirroir-mcp) for details.
 
 ## License
 

package/bin/mirroir-mcp

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // ABOUTME: Thin wrapper that launches the native MCP server binary.
-// ABOUTME: Routes "setup" and "install" subcommands to their respective scripts.
+// ABOUTME: Routes "install" subcommand to the interactive MCP client configuration script.
 
 const { execFileSync } = require("child_process");
 const fs = require("fs");
@@ -9,10 +9,9 @@ const path = require("path");
 const binDir = __dirname;
 const pkgDir = path.dirname(binDir);
 const binary = path.join(binDir, "mirroir-mcp-native");
-const setupScript = path.join(pkgDir, "setup.js");
 const installScript = path.join(pkgDir, "install-cmd.js");
 
-// Handle "install" subcommand — full interactive installer (Karabiner + helper + MCP client)
+// Handle "install" subcommand — interactive MCP client configuration
 if (process.argv[2] === "install") {
   if (!fs.existsSync(installScript)) {
     console.error("Install script not found. Run: npm rebuild mirroir-mcp");
@@ -27,24 +26,7 @@ if (process.argv[2] === "install") {
   process.exit(0);
 }
 
-// Handle "setup" subcommand — interactive helper daemon installation
-if (process.argv[2] === "setup") {
-  if (!fs.existsSync(setupScript)) {
-    console.error("Setup script not found. Run: npm rebuild mirroir-mcp");
-    process.exit(1);
-  }
-  try {
-    execFileSync("node", [setupScript], { stdio: "inherit" });
-  } catch (e) {
-    console.error("Setup failed. See https://github.com/jfarcand/mirroir-mcp for manual install.");
-    process.exit(1);
-  }
-  process.exit(0);
-}
-
-// Run the MCP server — starts regardless of helper daemon state.
-// If the helper isn't running, tools return helpful error messages
-// telling the user to run: npx mirroir-mcp setup
+// Run the MCP server
 try {
   execFileSync(binary, process.argv.slice(2), { stdio: "inherit" });
 } catch (e) {

package/install-cmd.js

@@ -1,100 +1,15 @@
 #!/usr/bin/env node
 // ABOUTME: Interactive one-command installer for mirroir-mcp.
-// ABOUTME: Handles standalone DriverKit install (or reuses Karabiner-Elements), helper daemon setup, and MCP client configuration.
+// ABOUTME: Builds from source if in a checkout, then configures the MCP client.
 
-const { execSync, execFileSync, spawnSync } = require("child_process");
+const { execSync } = require("child_process");
 const fs = require("fs");
 const path = require("path");
 const readline = require("readline");
 
-const HELPER_SOCK = "/var/run/mirroir-helper.sock";
-const KARABINER_APP = "/Applications/Karabiner-Elements.app";
-const DRIVERKIT_MANAGER = "/Applications/.Karabiner-VirtualHIDDevice-Manager.app/Contents/MacOS/Karabiner-VirtualHIDDevice-Manager";
-const DRIVERKIT_VERSION = "6.10.0";
-const DRIVERKIT_PKG = `Karabiner-DriverKit-VirtualHIDDevice-${DRIVERKIT_VERSION}.pkg`;
-const DRIVERKIT_URL = `https://github.com/pqrs-org/Karabiner-DriverKit-VirtualHIDDevice/releases/download/v${DRIVERKIT_VERSION}/${DRIVERKIT_PKG}`;
-const KARABINER_SOCK_DIR = "/Library/Application Support/org.pqrs/tmp/rootonly/vhidd_server";
-const SETUP_SCRIPT = path.join(__dirname, "setup.js");
 const BIN_DIR = path.join(__dirname, "bin");
 const REPO_ROOT = path.dirname(__dirname);
 
-// --- DriverKit ---
-
-function hasVhiddSocket() {
-  try {
-    const result = spawnSync("sudo", ["bash", "-c",
-      `ls '${KARABINER_SOCK_DIR}'/*.sock`
-    ], { timeout: 5000, stdio: ["pipe", "pipe", "pipe"] });
-    return result.status === 0;
-  } catch (checkErr) {
-    return false;
-  }
-}
-
-function ensureDriverKit() {
-  if (hasVhiddSocket()) {
-    const provider = fs.existsSync(KARABINER_APP) ? "Karabiner-Elements" : "standalone DriverKit";
-    console.log(`[1/3] DriverKit virtual HID is running (${provider}).`);
-    return;
-  }
-
-  if (fs.existsSync(KARABINER_APP)) {
-    console.log("[1/3] Karabiner-Elements is installed but the DriverKit extension is not running.");
-    console.log("  Approve the extension in System Settings:");
-    console.log("  System Settings > General > Login Items & Extensions");
-    console.log("  Enable all toggles under Karabiner-Elements");
-    console.log("");
-    console.log("Press Enter once you have approved the extension...");
-    spawnSync("bash", ["-c", "read -r"], { stdio: "inherit" });
-    return;
-  }
-
-  if (fs.existsSync(DRIVERKIT_MANAGER)) {
-    console.log("[1/3] Standalone DriverKit is installed but the extension is not running.");
-    console.log("  Activating...");
-    try {
-      execSync(`"${DRIVERKIT_MANAGER}" activate`, { stdio: "inherit" });
-    } catch (activateErr) {
-      // Activation may fail if already activated — continue
-    }
-    console.log("  Approve the extension in System Settings > General > Login Items & Extensions.");
-    console.log("");
-    console.log("Press Enter once you have approved the extension...");
-    spawnSync("bash", ["-c", "read -r"], { stdio: "inherit" });
-    return;
-  }
-
-  console.log("[1/3] Installing standalone Karabiner DriverKit package...");
-
-  const tmpPkg = `/tmp/${DRIVERKIT_PKG}`;
-  try {
-    execSync(`curl -fSL -o "${tmpPkg}" "${DRIVERKIT_URL}"`, { stdio: "inherit" });
-    execSync(`sudo installer -pkg "${tmpPkg}" -target /`, { stdio: "inherit" });
-    execSync(`rm -f "${tmpPkg}"`, { stdio: "ignore" });
-  } catch (installErr) {
-    console.error("Failed to install DriverKit package.");
-    console.error(`Download manually from: https://github.com/pqrs-org/Karabiner-DriverKit-VirtualHIDDevice/releases`);
-    process.exit(1);
-  }
-
-  console.log("");
-  console.log("Activating DriverKit system extension...");
-  try {
-    execSync(`"${DRIVERKIT_MANAGER}" activate`, { stdio: "inherit" });
-  } catch (activateErr) {
-    // Continue — user will approve in System Settings
-  }
-
-  console.log("");
-  console.log("Approve the system extension in System Settings:");
-  console.log("  System Settings > General > Login Items & Extensions");
-  console.log("  Enable the Karabiner-DriverKit-VirtualHIDDevice toggle");
-  console.log("");
-  console.log("Press Enter once you have approved the extension...");
-
-  spawnSync("bash", ["-c", "read -r"], { stdio: "inherit" });
-}
-
 // --- Source Build ---
 
 function isSourceCheckout() {
@@ -106,56 +21,10 @@ function buildFromSource() {
   execSync("swift build -c release", { cwd: REPO_ROOT, stdio: "inherit" });
 
   const releaseBin = path.join(REPO_ROOT, ".build", "release");
-  const plistSrc = path.join(REPO_ROOT, "Resources", "com.jfarcand.mirroir-helper.plist");
 
   fs.mkdirSync(BIN_DIR, { recursive: true });
-  fs.copyFileSync(path.join(releaseBin, "mirroir-helper"), path.join(BIN_DIR, "mirroir-helper"));
-  fs.chmodSync(path.join(BIN_DIR, "mirroir-helper"), 0o755);
   fs.copyFileSync(path.join(releaseBin, "mirroir-mcp"), path.join(BIN_DIR, "mirroir-mcp-native"));
   fs.chmodSync(path.join(BIN_DIR, "mirroir-mcp-native"), 0o755);
-  fs.copyFileSync(plistSrc, path.join(BIN_DIR, "com.jfarcand.mirroir-helper.plist"));
-}
-
-// --- Helper Daemon ---
-
-function isHelperRunning() {
-  if (!fs.existsSync(HELPER_SOCK)) return false;
-  try {
-    const result = spawnSync("bash", ["-c",
-      `echo '{"action":"status"}' | nc -U ${HELPER_SOCK} 2>/dev/null`
-    ], { timeout: 3000 });
-    const output = result.stdout ? result.stdout.toString() : "";
-    return output.includes('"ok"');
-  } catch (socketErr) {
-    return false;
-  }
-}
-
-function ensureHelper() {
-  if (isHelperRunning()) {
-    console.log("[2/3] Helper daemon is running.");
-    return;
-  }
-
-  console.log("[2/3] Helper daemon not running. Setting up...");
-
-  // If helper binary is missing and we're in a source checkout, build first
-  const helperBin = path.join(BIN_DIR, "mirroir-helper");
-  if (!fs.existsSync(helperBin) && isSourceCheckout()) {
-    buildFromSource();
-  }
-
-  if (!fs.existsSync(SETUP_SCRIPT)) {
-    console.error("Setup script not found. Run: npm rebuild mirroir-mcp");
-    process.exit(1);
-  }
-
-  try {
-    execFileSync("node", [SETUP_SCRIPT], { stdio: "inherit" });
-  } catch (setupErr) {
-    console.error("Helper setup failed. See https://github.com/jfarcand/mirroir-mcp for manual install.");
-    process.exit(1);
-  }
 }
 
 // --- MCP Client Configuration ---
@@ -174,7 +43,7 @@ function ask(question) {
 }
 
 async function configureMcpClient() {
-  console.log("[3/3] Configure MCP client");
+  console.log("[1/1] Configure MCP client");
   console.log("");
   console.log("  1) Claude Code");
   console.log("  2) Cursor");
@@ -377,8 +246,12 @@ async function main() {
   console.log("=== mirroir-mcp installer ===");
   console.log("");
 
-  ensureDriverKit();
-  ensureHelper();
+  // Build from source if in a development checkout
+  const nativeBin = path.join(BIN_DIR, "mirroir-mcp-native");
+  if (!fs.existsSync(nativeBin) && isSourceCheckout()) {
+    buildFromSource();
+  }
+
   await configureMcpClient();
 
   console.log("");

package/install.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
-// Downloads the pre-built mirroir-mcp and mirroir-helper binaries
-// plus the LaunchDaemon plist from GitHub releases.
+// Downloads the pre-built mirroir-mcp binary from GitHub releases.
 // Only supports macOS (darwin) since iPhone Mirroring is a macOS feature.
 
 const https = require("https");
@@ -9,7 +8,7 @@ const fs = require("fs");
 const path = require("path");
 const { execSync } = require("child_process");
 
-const VERSION = "0.18.0";
+const VERSION = "0.20.0";
 const REPO = "jfarcand/mirroir-mcp";
 const BINARY = "mirroir-mcp";
 
@@ -48,7 +47,7 @@ function main() {
 
   download(url, tmpFile, () => {
     verifyChecksum(tarball, tmpFile, () => {
-    // Extract all files: mirroir-mcp, mirroir-helper, plist
+    // Extract mirroir-mcp binary
     execSync(`tar xzf "${tmpFile}" -C "${binDir}"`, { stdio: "inherit" });
 
     // Rename native binary to -native to avoid conflicting with the JS wrapper
@@ -62,12 +61,6 @@ function main() {
       fs.unlinkSync(jsWrapperBackup);
     }
 
-    // Make helper executable
-    const helperBin = path.join(binDir, "mirroir-helper");
-    if (fs.existsSync(helperBin)) {
-      fs.chmodSync(helperBin, 0o755);
-    }
-
     fs.unlinkSync(tmpFile);
     console.log(`Installed binaries to ${binDir}`);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mirroir-mcp",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "MCP server that controls a real iPhone through macOS iPhone Mirroring. Screenshot, tap, swipe, type — from any MCP client.",
   "mcpName": "io.github.jfarcand/mirroir-mcp",
   "license": "Apache-2.0",
@@ -30,7 +30,6 @@
     "bin/",
     "install.js",
     "install-cmd.js",
-    "setup.js",
     "prompts/",
     "agents/",
     "README.md"

package/bin/com.jfarcand.mirroir-helper.plist

@@ -1,18 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-    <key>Label</key>
-    <string>com.jfarcand.mirroir-helper</string>
-    <key>ProgramArguments</key>
-    <array>
-        <string>/usr/local/bin/mirroir-helper</string>
-    </array>
-    <key>RunAtLoad</key>
-    <true/>
-    <key>KeepAlive</key>
-    <true/>
-    <key>StandardErrorPath</key>
-    <string>/var/log/mirroir-helper.log</string>
-</dict>
-</plist>

package/setup.js

@@ -1,237 +0,0 @@
-#!/usr/bin/env node
-// Sets up the mirroir-helper daemon as a macOS LaunchDaemon.
-// Requires sudo for copying the helper binary and plist to system directories.
-
-const { execSync, spawnSync } = require("child_process");
-const fs = require("fs");
-const path = require("path");
-
-const PLIST_NAME = "com.jfarcand.mirroir-helper";
-const HELPER_SOCK = "/var/run/mirroir-helper.sock";
-const HELPER_DEST = "/usr/local/bin/mirroir-helper";
-const PLIST_DEST = `/Library/LaunchDaemons/${PLIST_NAME}.plist`;
-const KARABINER_SOCK_DIR = "/Library/Application Support/org.pqrs/tmp/rootonly/vhidd_server";
-const DRIVERKIT_MANAGER = "/Applications/.Karabiner-VirtualHIDDevice-Manager.app/Contents/MacOS/Karabiner-VirtualHIDDevice-Manager";
-const DRIVERKIT_VERSION = "6.10.0";
-const DRIVERKIT_URL = `https://github.com/pqrs-org/Karabiner-DriverKit-VirtualHIDDevice/releases/download/v${DRIVERKIT_VERSION}/Karabiner-DriverKit-VirtualHIDDevice-${DRIVERKIT_VERSION}.pkg`;
-
-function main() {
-  const binDir = path.join(__dirname, "bin");
-  const helperSrc = path.join(binDir, "mirroir-helper");
-  const plistSrc = path.join(binDir, `${PLIST_NAME}.plist`);
-
-  if (!fs.existsSync(helperSrc)) {
-    console.error("Helper binary not found. Run: npm rebuild mirroir-mcp");
-    process.exit(1);
-  }
-
-  if (!fs.existsSync(plistSrc)) {
-    console.error("LaunchDaemon plist not found. Run: npm rebuild mirroir-mcp");
-    process.exit(1);
-  }
-
-  // Check if DriverKit virtual HID is available (works for both standalone and Karabiner-Elements)
-  if (!hasVhiddSocket()) {
-    if (fs.existsSync("/Applications/Karabiner-Elements.app")) {
-      console.log("");
-      console.log("Karabiner-Elements is installed but the DriverKit extension is not running.");
-      console.log("Approve the extension in System Settings:");
-      console.log("  System Settings > General > Login Items & Extensions");
-      console.log("  Enable all toggles under Karabiner-Elements");
-      console.log("");
-      console.log("After that, re-run setup.");
-      process.exit(1);
-    } else if (fs.existsSync(DRIVERKIT_MANAGER)) {
-      console.log("");
-      console.log("Standalone DriverKit is installed but the extension is not running.");
-      console.log("Activate it:");
-      console.log(`  ${DRIVERKIT_MANAGER} activate`);
-      console.log("");
-      console.log("Then approve in System Settings > General > Login Items & Extensions.");
-      console.log("After that, re-run setup.");
-      process.exit(1);
-    } else {
-      console.log("");
-      console.log("A DriverKit virtual HID device is required for tap and swipe input.");
-      console.log("");
-      console.log("Install the standalone Karabiner DriverKit package:");
-      console.log(`  curl -fSL -o /tmp/driverkit.pkg "${DRIVERKIT_URL}"`);
-      console.log("  sudo installer -pkg /tmp/driverkit.pkg -target /");
-      console.log(`  ${DRIVERKIT_MANAGER} activate`);
-      console.log("");
-      console.log("Then approve the extension in System Settings > General > Login Items & Extensions.");
-      console.log("After that, re-run setup.");
-      process.exit(1);
-    }
-  }
-
-  console.log("=== Setting up mirroir-helper daemon ===");
-  console.log("");
-  console.log("This requires administrator privileges to install the helper daemon.");
-  console.log("");
-
-  // Stop existing daemon if running
-  try {
-    execSync(`sudo launchctl bootout system/${PLIST_NAME} 2>/dev/null`, { stdio: "inherit" });
-    spawnSync("sleep", ["1"]);
-  } catch (ignoreNotRunning) {
-    // Daemon wasn't loaded, safe to continue
-  }
-
-  // Copy helper binary
-  execSync(`sudo cp "${helperSrc}" "${HELPER_DEST}"`, { stdio: "inherit" });
-  execSync(`sudo chmod 755 "${HELPER_DEST}"`, { stdio: "inherit" });
-
-  // Copy and configure plist
-  execSync(`sudo cp "${plistSrc}" "${PLIST_DEST}"`, { stdio: "inherit" });
-  execSync(`sudo chown root:wheel "${PLIST_DEST}"`, { stdio: "inherit" });
-  execSync(`sudo chmod 644 "${PLIST_DEST}"`, { stdio: "inherit" });
-
-  // Start daemon
-  execSync(`sudo launchctl bootstrap system "${PLIST_DEST}"`, { stdio: "inherit" });
-
-  // Configure Karabiner ignore rule only when Karabiner-Elements is installed
-  // (the ignore rule prevents the grabber from intercepting our virtual keyboard;
-  // standalone DriverKit has no grabber)
-  if (fs.existsSync("/Applications/Karabiner-Elements.app")) {
-    configureKarabiner();
-  } else {
-    console.log("Using standalone DriverKit (no Karabiner grabber, ignore rule not needed).");
-  }
-
-  // Wait for helper to become ready
-  console.log("");
-  console.log("Waiting for helper daemon...");
-  let ready = false;
-  for (let i = 0; i < 15; i++) {
-    spawnSync("sleep", ["2"]);
-    if (checkHelper()) {
-      ready = true;
-      break;
-    }
-  }
-
-  console.log("");
-  if (ready) {
-    console.log("=== Helper daemon is running ===");
-  } else {
-    console.log("Helper daemon started but may need more time to initialize.");
-    console.log("Check: echo '{\"action\":\"status\"}' | nc -U " + HELPER_SOCK);
-  }
-
-  // Install prompts and agent profiles to global config dir
-  installPromptsAndAgents();
-}
-
-function installPromptsAndAgents() {
-  const globalConfigDir = path.join(process.env.HOME || "", ".mirroir-mcp");
-  const promptsDir = path.join(globalConfigDir, "prompts");
-  const agentsDir = path.join(globalConfigDir, "agents");
-
-  fs.mkdirSync(promptsDir, { recursive: true });
-  fs.mkdirSync(agentsDir, { recursive: true });
-
-  // Source directories are in the npm package alongside setup.js
-  const srcPromptsDir = path.join(__dirname, "prompts");
-  const srcAgentsDir = path.join(__dirname, "agents");
-
-  // Copy prompts (skip if user has customized)
-  if (fs.existsSync(srcPromptsDir)) {
-    for (const file of fs.readdirSync(srcPromptsDir)) {
-      if (!file.endsWith(".md")) continue;
-      const dest = path.join(promptsDir, file);
-      if (!fs.existsSync(dest)) {
-        fs.copyFileSync(path.join(srcPromptsDir, file), dest);
-        console.log(`  Installed: ${dest}`);
-      }
-    }
-  }
-
-  // Copy agent profiles (skip if user has customized)
-  if (fs.existsSync(srcAgentsDir)) {
-    for (const file of fs.readdirSync(srcAgentsDir)) {
-      if (!file.endsWith(".yaml")) continue;
-      const dest = path.join(agentsDir, file);
-      if (!fs.existsSync(dest)) {
-        fs.copyFileSync(path.join(srcAgentsDir, file), dest);
-        console.log(`  Installed: ${dest}`);
-      }
-    }
-  }
-}
-
-function checkHelper() {
-  if (!fs.existsSync(HELPER_SOCK)) return false;
-  try {
-    const result = spawnSync("bash", ["-c",
-      `echo '{"action":"status"}' | nc -U ${HELPER_SOCK} 2>/dev/null`
-    ], { timeout: 3000 });
-    const output = result.stdout ? result.stdout.toString() : "";
-    return output.includes('"ok"');
-  } catch (socketError) {
-    return false;
-  }
-}
-
-function hasVhiddSocket() {
-  try {
-    // Socket dir is mode 700 — glob expansion needs sudo bash -c
-    const result = spawnSync("sudo", ["bash", "-c",
-      `ls '${KARABINER_SOCK_DIR}'/*.sock`
-    ], { timeout: 5000, stdio: ["pipe", "pipe", "pipe"] });
-    return result.status === 0;
-  } catch (checkError) {
-    return false;
-  }
-}
-
-function configureKarabiner() {
-  const configPath = path.join(
-    process.env.HOME || "",
-    ".config/karabiner/karabiner.json"
-  );
-
-  if (!fs.existsSync(configPath)) {
-    // Create minimal config with ignore rule
-    const configDir = path.dirname(configPath);
-    fs.mkdirSync(configDir, { recursive: true });
-    const config = {
-      profiles: [{
-        devices: [{
-          identifiers: { is_keyboard: true, product_id: 592, vendor_id: 1452 },
-          ignore: true
-        }],
-        name: "Default profile",
-        selected: true,
-        virtual_hid_keyboard: { keyboard_type_v2: "ansi" }
-      }]
-    };
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 4));
-    console.log("Created Karabiner config with device ignore rule.");
-    return;
-  }
-
-  // Check if rule already exists
-  const content = fs.readFileSync(configPath, "utf8");
-  if (content.includes('"product_id": 592') || content.includes('"product_id":592')) {
-    return;
-  }
-
-  // Add ignore rule to first profile
-  try {
-    const config = JSON.parse(content);
-    const profile = config.profiles[0];
-    if (!profile.devices) profile.devices = [];
-    profile.devices.push({
-      identifiers: { is_keyboard: true, product_id: 592, vendor_id: 1452 },
-      ignore: true
-    });
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 4));
-    console.log("Added device ignore rule to Karabiner config.");
-  } catch (parseError) {
-    console.log("Warning: Could not update Karabiner config automatically.");
-    console.log("Add this device ignore rule manually: product_id 592, vendor_id 1452");
-  }
-}
-
-main();