@abacus-ai/cli 1.106.25008 → 2.0.0-canary.1

package/src/terminal/setup.ts

@@ -0,0 +1,797 @@
+import { execFile } from "node:child_process";
+import { randomBytes } from "node:crypto";
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import process from "node:process";
+import { promisify } from "node:util";
+
+import type { TerminalType, TerminalSetupResult } from "./types.js";
+
+import { getTerminal, getNewlineInstructions } from "./detection.js";
+
+const SHIFT_ENTER_SEQUENCE = "\\x1b\\r";
+const SHIFT_ENTER_SEQUENCE_LITERAL = "\x1b\r";
+const execFileAsync = promisify(execFile);
+
+function createBackup(filePath: string): string | null {
+  if (!fs.existsSync(filePath)) {
+    return null;
+  }
+  const backupId = randomBytes(4).toString("hex");
+  const backupPath = `${filePath}.${backupId}.bak`;
+  try {
+    fs.copyFileSync(filePath, backupPath);
+    return backupPath;
+  } catch {
+    return null;
+  }
+}
+
+async function setupVSCodeKeybindings(
+  editorName: "Code" | "Cursor" | "Windsurf" | "VSCodium",
+): Promise<TerminalSetupResult> {
+  const home = os.homedir();
+  let configDir: string;
+
+  if (process.platform === "win32") {
+    configDir = path.join(home, "AppData", "Roaming", editorName, "User");
+  } else if (process.platform === "darwin") {
+    configDir = path.join(home, "Library", "Application Support", editorName, "User");
+  } else {
+    configDir = path.join(home, ".config", editorName, "User");
+  }
+
+  const keybindingsPath = path.join(configDir, "keybindings.json");
+
+  try {
+    if (!fs.existsSync(configDir)) {
+      fs.mkdirSync(configDir, { recursive: true });
+    }
+
+    let keybindings: Array<{
+      key: string;
+      command: string;
+      args?: Record<string, string>;
+      when?: string;
+    }> = [];
+
+    if (fs.existsSync(keybindingsPath)) {
+      const content = fs.readFileSync(keybindingsPath, "utf-8");
+      const backupPath = createBackup(keybindingsPath);
+      if (!backupPath) {
+        return {
+          success: false,
+          message: `Failed to backup existing ${editorName} keybindings`,
+        };
+      }
+
+      const cleanContent = content.replace(/\/\/.*$/gm, "").replace(/\/\*[\s\S]*?\*\//g, "");
+      try {
+        keybindings = JSON.parse(cleanContent || "[]");
+      } catch {
+        keybindings = [];
+      }
+
+      const existing = keybindings.find(
+        (kb) =>
+          kb.key === "shift+enter" &&
+          kb.command === "workbench.action.terminal.sendSequence" &&
+          kb.when === "terminalFocus",
+      );
+
+      if (existing) {
+        return {
+          success: false,
+          message: `Found existing ${editorName} Shift+Enter key binding. Remove it to continue.\nSee: ${keybindingsPath}`,
+        };
+      }
+    }
+
+    keybindings.push({
+      key: "shift+enter",
+      command: "workbench.action.terminal.sendSequence",
+      args: { text: SHIFT_ENTER_SEQUENCE_LITERAL },
+      when: "terminalFocus",
+    });
+
+    fs.writeFileSync(keybindingsPath, JSON.stringify(keybindings, null, 2), "utf-8");
+
+    return {
+      success: true,
+      message: `Installed ${editorName} terminal Shift+Enter key binding\nSee: ${keybindingsPath}`,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to install ${editorName} terminal Shift+Enter key binding: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+async function exec(
+  command: string,
+  args: string[],
+): Promise<{ stdout: string; stderr: string; code: number }> {
+  try {
+    const { stdout, stderr } = await execFileAsync(command, args, { encoding: "utf8" });
+    return { stdout, stderr, code: 0 };
+  } catch (error: unknown) {
+    if (error && typeof error === "object" && "code" in error) {
+      const execError = error as { stdout?: string; stderr?: string; code?: number };
+      return {
+        stdout: execError.stdout || "",
+        stderr: execError.stderr || "",
+        code: typeof execError.code === "number" ? execError.code : 1,
+      };
+    }
+    return {
+      stdout: "",
+      stderr: error instanceof Error ? error.message : String(error),
+      code: 1,
+    };
+  }
+}
+
+async function setupITerm2(): Promise<TerminalSetupResult> {
+  if (process.platform !== "darwin") {
+    return { success: false, message: "iTerm2 setup is only available on macOS" };
+  }
+
+  try {
+    const { code } = await exec("defaults", [
+      "write",
+      "com.googlecode.iterm2",
+      "GlobalKeyMap",
+      "-dict-add",
+      "0xd-0x20000",
+      `<dict><key>Text</key><string>${SHIFT_ENTER_SEQUENCE_LITERAL}</string><key>Action</key><integer>12</integer></dict>`,
+    ]);
+
+    if (code !== 0) {
+      return { success: false, message: "Failed to install iTerm2 Shift+Enter key binding" };
+    }
+
+    return {
+      success: true,
+      message:
+        "Installed iTerm2 Shift+Enter key binding\nRestart iTerm2 for changes to take effect.",
+      requiresRestart: true,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to configure iTerm2: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+async function setupAppleTerminal(): Promise<TerminalSetupResult> {
+  if (process.platform !== "darwin") {
+    return { success: false, message: "Apple Terminal setup is only available on macOS" };
+  }
+
+  const plistPath = path.join(os.homedir(), "Library", "Preferences", "com.apple.Terminal.plist");
+  const backupPath = createBackup(plistPath);
+
+  try {
+    const { stdout: defaultProfile, code: defaultCode } = await exec("defaults", [
+      "read",
+      "com.apple.Terminal",
+      "Default Window Settings",
+    ]);
+
+    if (defaultCode !== 0 || !defaultProfile.trim()) {
+      return { success: false, message: "Failed to read default Terminal.app profile" };
+    }
+
+    const profile = defaultProfile.trim();
+
+    let { code } = await exec("/usr/libexec/PlistBuddy", [
+      "-c",
+      `Add :'Window Settings':'${profile}':useOptionAsMetaKey bool true`,
+      plistPath,
+    ]);
+
+    if (code !== 0) {
+      ({ code } = await exec("/usr/libexec/PlistBuddy", [
+        "-c",
+        `Set :'Window Settings':'${profile}':useOptionAsMetaKey true`,
+        plistPath,
+      ]));
+    }
+
+    await exec("killall", ["cfprefsd"]);
+
+    return {
+      success: true,
+      message: `Configured Terminal.app to use Option as Meta key\nOption+Enter will now insert a newline\nRestart Terminal.app for changes to take effect.`,
+      requiresRestart: true,
+      backupPath: backupPath || undefined,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to configure Terminal.app: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+async function setupGhosttyKeybindings(): Promise<TerminalSetupResult> {
+  const configPaths: string[] = [];
+
+  const xdgConfigHome = process.env.XDG_CONFIG_HOME;
+  if (xdgConfigHome) {
+    configPaths.push(path.join(xdgConfigHome, "ghostty", "config"));
+  } else {
+    configPaths.push(path.join(os.homedir(), ".config", "ghostty", "config"));
+  }
+
+  if (process.platform === "darwin") {
+    configPaths.push(
+      path.join(os.homedir(), "Library", "Application Support", "com.mitchellh.ghostty", "config"),
+    );
+  }
+
+  let configPath: string | null = null;
+  let configExists = false;
+
+  for (const p of configPaths) {
+    if (fs.existsSync(p)) {
+      configPath = p;
+      configExists = true;
+      break;
+    }
+  }
+
+  if (!configPath) {
+    configPath = configPaths[0]!;
+  }
+
+  try {
+    let content = "";
+
+    if (configExists) {
+      content = fs.readFileSync(configPath, "utf-8");
+
+      if (content.includes("shift+enter")) {
+        return {
+          success: false,
+          message: `Found existing Ghostty Shift+Enter key binding. Remove it to continue.\nSee: ${configPath}`,
+        };
+      }
+
+      const backupPath = createBackup(configPath);
+      if (!backupPath) {
+        return {
+          success: false,
+          message: `Failed to backup existing Ghostty config`,
+        };
+      }
+    } else {
+      const configDir = path.dirname(configPath);
+      if (!fs.existsSync(configDir)) {
+        fs.mkdirSync(configDir, { recursive: true });
+      }
+    }
+
+    let newContent = content;
+    if (content && !content.endsWith("\n")) {
+      newContent += "\n";
+    }
+    newContent += `keybind = shift+enter=text:${SHIFT_ENTER_SEQUENCE}\n`;
+
+    fs.writeFileSync(configPath, newContent, "utf-8");
+
+    return {
+      success: true,
+      message: `Installed Ghostty Shift+Enter key binding\nSee: ${configPath}`,
+      requiresRestart: true,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to install Ghostty Shift+Enter key binding: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+async function setupWezTermKeybindings(): Promise<TerminalSetupResult> {
+  const configPath = path.join(os.homedir(), ".wezterm.lua");
+
+  try {
+    let content = "";
+    let configExists = false;
+
+    if (fs.existsSync(configPath)) {
+      configExists = true;
+      content = fs.readFileSync(configPath, "utf-8");
+
+      if (content.includes('mods="SHIFT"') && content.includes('key="Enter"')) {
+        return {
+          success: false,
+          message: `Found existing WezTerm Shift+Enter key binding. Remove it to continue.\nSee: ${configPath}`,
+        };
+      }
+
+      const backupPath = createBackup(configPath);
+      if (!backupPath) {
+        return {
+          success: false,
+          message: `Failed to backup existing WezTerm config`,
+        };
+      }
+    }
+
+    const keybinding = `{key="Enter", mods="SHIFT", action=wezterm.action{SendString="${SHIFT_ENTER_SEQUENCE}"}}`;
+
+    if (!configExists) {
+      content = `local wezterm = require 'wezterm'
+local config = wezterm.config_builder()
+
+config.keys = {
+  ${keybinding},
+}
+
+return config
+`;
+    } else {
+      const keysMatch = content.match(/config\.keys\s*=\s*\{([^}]*)\}/s);
+      if (keysMatch) {
+        const existingKeys = keysMatch[1] ?? "";
+        const newKeys = existingKeys.trim()
+          ? `${existingKeys.trim()},\n  ${keybinding},`
+          : `\n  ${keybinding},\n`;
+        content = content.replace(/config\.keys\s*=\s*\{[^}]*\}/s, `config.keys = {${newKeys}}`);
+      } else if (content.match(/return\s+config/s)) {
+        content = content.replace(
+          /return\s+config/s,
+          `config.keys = {\n  ${keybinding},\n}\n\nreturn config`,
+        );
+      } else {
+        content += `\nconfig.keys = {\n  ${keybinding},\n}\n`;
+      }
+    }
+
+    fs.writeFileSync(configPath, content, "utf-8");
+
+    return {
+      success: true,
+      message: `Installed WezTerm Shift+Enter key binding\nSee: ${configPath}`,
+      requiresRestart: true,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to install WezTerm Shift+Enter key binding: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+async function setupKittyKeybindings(): Promise<TerminalSetupResult> {
+  const configPaths: string[] = [];
+
+  const xdgConfigHome = process.env.XDG_CONFIG_HOME;
+  if (xdgConfigHome) {
+    configPaths.push(path.join(xdgConfigHome, "kitty", "kitty.conf"));
+  } else {
+    configPaths.push(path.join(os.homedir(), ".config", "kitty", "kitty.conf"));
+  }
+
+  if (process.platform === "darwin") {
+    configPaths.push(path.join(os.homedir(), "Library", "Preferences", "kitty", "kitty.conf"));
+  }
+
+  let configPath: string | null = null;
+  let configExists = false;
+
+  for (const p of configPaths) {
+    if (fs.existsSync(p)) {
+      configPath = p;
+      configExists = true;
+      break;
+    }
+  }
+
+  if (!configPath) {
+    configPath = configPaths[0]!;
+  }
+
+  try {
+    let content = "";
+
+    if (configExists) {
+      content = fs.readFileSync(configPath, "utf-8");
+
+      if (content.includes("shift+enter") && content.includes("send_text")) {
+        return {
+          success: false,
+          message: `Found existing Kitty Shift+Enter key binding. Remove it to continue.\nSee: ${configPath}`,
+        };
+      }
+
+      const backupPath = createBackup(configPath);
+      if (!backupPath) {
+        return {
+          success: false,
+          message: `Failed to backup existing Kitty config`,
+        };
+      }
+    } else {
+      const configDir = path.dirname(configPath);
+      if (!fs.existsSync(configDir)) {
+        fs.mkdirSync(configDir, { recursive: true });
+      }
+    }
+
+    let newContent = content;
+    if (content && !content.endsWith("\n")) {
+      newContent += "\n";
+    }
+    newContent += `map shift+enter send_text all ${SHIFT_ENTER_SEQUENCE}\n`;
+
+    fs.writeFileSync(configPath, newContent, "utf-8");
+
+    return {
+      success: true,
+      message: `Installed Kitty Shift+Enter key binding\nSee: ${configPath}`,
+      requiresRestart: true,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to install Kitty Shift+Enter key binding: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+async function setupAlacrittyKeybindings(): Promise<TerminalSetupResult> {
+  const configPaths: string[] = [];
+
+  const xdgConfigHome = process.env.XDG_CONFIG_HOME;
+  if (xdgConfigHome) {
+    configPaths.push(path.join(xdgConfigHome, "alacritty", "alacritty.toml"));
+    configPaths.push(path.join(xdgConfigHome, "alacritty", "alacritty.yml"));
+  } else {
+    configPaths.push(path.join(os.homedir(), ".config", "alacritty", "alacritty.toml"));
+    configPaths.push(path.join(os.homedir(), ".config", "alacritty", "alacritty.yml"));
+  }
+
+  if (process.platform === "darwin") {
+    configPaths.push(path.join(os.homedir(), ".alacritty.toml"));
+    configPaths.push(path.join(os.homedir(), ".alacritty.yml"));
+  }
+
+  let configPath: string | null = null;
+  let configExists = false;
+  let isToml = true;
+
+  for (const p of configPaths) {
+    if (fs.existsSync(p)) {
+      configPath = p;
+      configExists = true;
+      isToml = p.endsWith(".toml");
+      break;
+    }
+  }
+
+  if (!configPath) {
+    configPath = configPaths[0]!;
+  }
+
+  try {
+    let content = "";
+
+    if (configExists) {
+      content = fs.readFileSync(configPath, "utf-8");
+
+      if (content.includes("Shift") && content.includes("Return")) {
+        return {
+          success: false,
+          message: `Found existing Alacritty Shift+Enter key binding. Remove it to continue.\nSee: ${configPath}`,
+        };
+      }
+
+      const backupPath = createBackup(configPath);
+      if (!backupPath) {
+        return {
+          success: false,
+          message: `Failed to backup existing Alacritty config`,
+        };
+      }
+    } else {
+      const configDir = path.dirname(configPath);
+      if (!fs.existsSync(configDir)) {
+        fs.mkdirSync(configDir, { recursive: true });
+      }
+    }
+
+    let newContent = content;
+    if (content && !content.endsWith("\n")) {
+      newContent += "\n";
+    }
+
+    if (isToml) {
+      newContent += `
+[[keyboard.bindings]]
+key = "Return"
+mods = "Shift"
+chars = "${SHIFT_ENTER_SEQUENCE}"
+`;
+    } else {
+      newContent += `
+key_bindings:
+  - { key: Return, mods: Shift, chars: "${SHIFT_ENTER_SEQUENCE}" }
+`;
+    }
+
+    fs.writeFileSync(configPath, newContent, "utf-8");
+
+    return {
+      success: true,
+      message: `Installed Alacritty Shift+Enter key binding\nSee: ${configPath}`,
+      requiresRestart: true,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      message: `Failed to install Alacritty Shift+Enter key binding: ${error instanceof Error ? error.message : String(error)}`,
+    };
+  }
+}
+
+export async function setupTerminal(): Promise<TerminalSetupResult> {
+  const terminal = getTerminal();
+
+  if (!terminal) {
+    return {
+      success: false,
+      message: "Could not detect terminal. You can use backslash (\\) + Enter for newlines.",
+    };
+  }
+
+  switch (terminal) {
+    case "cursor":
+      return setupVSCodeKeybindings("Cursor");
+    case "windsurf":
+      return setupVSCodeKeybindings("Windsurf");
+    case "vscode":
+      return setupVSCodeKeybindings("Code");
+    case "codium":
+      return setupVSCodeKeybindings("VSCodium");
+    case "ghostty":
+      return setupGhosttyKeybindings();
+    case "iTerm.app":
+      return setupITerm2();
+    case "Apple_Terminal":
+      return setupAppleTerminal();
+    case "WezTerm":
+      return setupWezTermKeybindings();
+    case "kitty":
+      return setupKittyKeybindings();
+    case "alacritty":
+      return setupAlacrittyKeybindings();
+    default:
+      return {
+        success: false,
+        message: `Terminal "${terminal}" is not supported for automatic setup.\n\nYou can use backslash (\\) + Enter for newlines.\n\nSupported terminals:\n- VS Code, Cursor, Windsurf, VSCodium\n- Ghostty\n- iTerm2\n- Apple Terminal\n- WezTerm\n- Kitty\n- Alacritty`,
+      };
+  }
+}
+
+export function getTerminalSetupInstructions(terminal?: TerminalType): string {
+  const detectedTerminal = terminal || getTerminal();
+  const newlineInstruction = getNewlineInstructions();
+
+  if (!detectedTerminal || detectedTerminal === "non-interactive") {
+    return `
+Could not detect your terminal.
+
+Current newline instruction: ${newlineInstruction}
+
+If you're using a supported terminal, please report this at:
+https://github.com/anthropics/claude-code/issues
+`.trim();
+  }
+
+  const instructions: Record<string, string> = {
+    cursor: `
+Detected Terminal: Cursor
+
+To enable Shift+Enter for newlines in Cursor's integrated terminal:
+
+1. Open Cursor Settings (Cmd/Ctrl + ,)
+2. Search for "keybindings"
+3. Click "Open Keyboard Shortcuts (JSON)"
+4. Add this keybinding:
+
+   {
+     "key": "shift+enter",
+     "command": "workbench.action.terminal.sendSequence",
+     "args": { "text": "\\u001b\\r" },
+     "when": "terminalFocus"
+   }
+
+5. Save and reload Cursor
+
+Current newline instruction: ${newlineInstruction}
+`,
+    windsurf: `
+Detected Terminal: Windsurf
+
+To enable Shift+Enter for newlines in Windsurf's integrated terminal:
+
+1. Open Windsurf Settings (Cmd/Ctrl + ,)
+2. Search for "keybindings"
+3. Click "Open Keyboard Shortcuts (JSON)"
+4. Add this keybinding:
+
+   {
+     "key": "shift+enter",
+     "command": "workbench.action.terminal.sendSequence",
+     "args": { "text": "\\u001b\\r" },
+     "when": "terminalFocus"
+   }
+
+5. Save and reload Windsurf
+
+Current newline instruction: ${newlineInstruction}
+`,
+    vscode: `
+Detected Terminal: Visual Studio Code
+
+To enable Shift+Enter for newlines in VS Code's integrated terminal:
+
+1. Open VS Code Settings (Cmd/Ctrl + ,)
+2. Search for "keybindings"
+3. Click "Open Keyboard Shortcuts (JSON)"
+4. Add this keybinding:
+
+   {
+     "key": "shift+enter",
+     "command": "workbench.action.terminal.sendSequence",
+     "args": { "text": "\\u001b\\r" },
+     "when": "terminalFocus"
+   }
+
+5. Save and reload VS Code
+
+Current newline instruction: ${newlineInstruction}
+`,
+    "iTerm.app": `
+Detected Terminal: iTerm2
+
+To enable Shift+Enter for newlines in iTerm2:
+
+1. Open iTerm2 Preferences (Cmd + ,)
+2. Go to "Keys" → "Key Bindings"
+3. Click the "+" button to add a new key binding
+4. Press Shift+Enter in the "Keyboard Shortcut" field
+5. Set "Action" to "Send Escape Sequence"
+6. Enter "\\r" (without quotes) in the text field
+7. Click OK
+
+Current newline instruction: ${newlineInstruction}
+`,
+    Apple_Terminal: `
+Detected Terminal: Apple Terminal
+
+Apple Terminal uses Option+Enter for newlines by default.
+
+Current newline instruction: ${newlineInstruction}
+
+No additional setup required!
+`,
+    ghostty: `
+Detected Terminal: Ghostty
+
+To enable Shift+Enter for newlines in Ghostty:
+
+1. Open your Ghostty config file:
+   ~/.config/ghostty/config
+
+2. Add this line:
+   keybind = shift+enter=text:\\x1b\\r
+
+3. Save and reload Ghostty
+
+Current newline instruction: ${newlineInstruction}
+`,
+    WezTerm: `
+Detected Terminal: WezTerm
+
+To enable Shift+Enter for newlines in WezTerm:
+
+1. Open your WezTerm config file:
+   ~/.wezterm.lua (or ~/.config/wezterm/wezterm.lua)
+
+2. Add this configuration:
+
+   config.keys = {
+     {
+       key = 'Enter',
+       mods = 'SHIFT',
+       action = wezterm.action.SendString '\\x1b\\r',
+     },
+   }
+
+3. Save and reload WezTerm
+
+Current newline instruction: ${newlineInstruction}
+`,
+    kitty: `
+Detected Terminal: Kitty
+
+To enable Shift+Enter for newlines in Kitty:
+
+1. Open your Kitty config file:
+   ~/.config/kitty/kitty.conf
+
+2. Add this line:
+   map shift+enter send_text all \\x1b\\r
+
+3. Save and reload Kitty (Cmd/Ctrl + Shift + F5)
+
+Current newline instruction: ${newlineInstruction}
+`,
+    alacritty: `
+Detected Terminal: Alacritty
+
+To enable Shift+Enter for newlines in Alacritty:
+
+1. Open your Alacritty config file:
+   ~/.config/alacritty/alacritty.yml (or alacritty.toml for newer versions)
+
+2. Add this configuration:
+
+   For YAML:
+   key_bindings:
+     - { key: Return, mods: Shift, chars: "\\x1b\\r" }
+
+   For TOML:
+   [[keyboard.bindings]]
+   key = "Return"
+   mods = "Shift"
+   chars = "\\x1b\\r"
+
+3. Save and reload Alacritty
+
+Current newline instruction: ${newlineInstruction}
+`,
+    "windows-terminal": `
+Detected Terminal: Windows Terminal
+
+To enable Shift+Enter for newlines in Windows Terminal:
+
+1. Open Windows Terminal Settings (Ctrl + ,)
+2. Click "Open JSON file" in the bottom left
+3. Add this to the "actions" array:
+
+   {
+     "command": { "action": "sendInput", "input": "\\u001b\\r" },
+     "keys": "shift+enter"
+   }
+
+4. Save and restart Windows Terminal
+
+Current newline instruction: ${newlineInstruction}
+`,
+  };
+
+  const instruction = instructions[detectedTerminal];
+  if (instruction) {
+    return instruction.trim();
+  }
+
+  return `
+Detected Terminal: ${detectedTerminal}
+
+Current newline instruction: ${newlineInstruction}
+
+Terminal-specific setup instructions are not available for this terminal.
+You can use backslash (\\) + Enter for newlines as a fallback.
+
+If you'd like support for your terminal, please report it at:
+https://github.com/anthropics/claude-code/issues
+`.trim();
+}