🤖 Add basic support for SSH runtime (#178)

Author: ammar-agent

.github/workflows/ci.yml

@@ -10,6 +10,8 @@ on:
         description: 'Optional test filter (e.g., "workspace", "tests/file.test.ts", or "-t pattern")'
         required: false
         type: string
+        # This filter is passed to unit tests, integration tests, e2e tests, and storybook tests
+        # to enable faster iteration when debugging specific test failures in CI
 
 jobs:
   static-check:
@@ -85,7 +87,7 @@ jobs:
 
   integration-test:
     name: Integration Tests
-    runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-16' || 'ubuntu-latest' }}
+    runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-24.04-32' || 'ubuntu-latest' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -95,7 +97,7 @@ jobs:
       - uses: ./.github/actions/setup-cmux
 
       - name: Run integration tests with coverage
-        run: TEST_INTEGRATION=1 bun x jest --coverage ${{ github.event.inputs.test_filter || 'tests' }}
+        run: TEST_INTEGRATION=1 bun x jest --coverage --maxWorkers=200% --silent ${{ github.event.inputs.test_filter || 'tests' }}
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
@@ -111,6 +113,7 @@ jobs:
   storybook-test:
     name: Storybook Interaction Tests
     runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-16' || 'ubuntu-latest' }}
+    if: github.event.inputs.test_filter == ''
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -136,6 +139,7 @@ jobs:
   e2e-test:
     name: End-to-End Tests
     runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-16' || 'ubuntu-latest' }}
+    if: github.event.inputs.test_filter == ''
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.gitignore

@@ -104,3 +104,4 @@ tmpfork
 .cmux-agent-cli
 storybook-static/
 *.tgz
+src/test-workspaces/

bun.lock

@@ -110,7 +110,7 @@ Verify with React DevTools Profiler - MarkdownCore should only re-render when co
 
 ## Documentation Guidelines
 
-**Free-floating markdown docs are not permitted.** Documentation must be organized:
+**Free-floating markdown docs are not permitted.** Documentation must be organized. Do not create standalone markdown files in the project root or random locations, even for implementation summaries or planning documents - use the propose_plan tool or inline comments instead.
 
 - **User-facing docs** → `./docs/` directory
   - **IMPORTANT**: Read `docs/README.md` first before writing user-facing documentation
@@ -119,6 +119,7 @@ Verify with React DevTools Profiler - MarkdownCore should only re-render when co
   - Use standard markdown + mermaid diagrams
 - **Developer docs** → inline with the code its documenting as comments. Consider them notes as notes to future Assistants to understand the logic more quickly.
   **DO NOT** create standalone documentation files in the project root or random locations.
+- **Test documentation** → inline comments in test files explaining complex test setup or edge cases, NOT separate README files.
 
 **NEVER create markdown documentation files (README, guides, summaries, etc.) in the project root during feature development unless the user explicitly requests documentation.** Code + tests + inline comments are complete documentation.
 
@@ -204,6 +205,7 @@ This project uses **Make** as the primary build orchestrator. See `Makefile` for
 - **Integration tests:**
   - Run specific integration test: `TEST_INTEGRATION=1 bun x jest tests/ipcMain/sendMessage.test.ts -t "test name pattern"`
   - Run all integration tests: `TEST_INTEGRATION=1 bun x jest tests` (~35 seconds, runs 40 tests)
+  - **⚠️ Running `tests/ipcMain` locally takes a very long time.** Prefer running specific test files or use `-t` to filter to specific tests.
   - **Performance**: Tests use `test.concurrent()` to run in parallel within each file
   - **NEVER bypass IPC in integration tests** - Integration tests must use the real IPC communication paths (e.g., `mockIpcRenderer.invoke()`) even when it's harder. Directly accessing services (HistoryService, PartialService, etc.) or manipulating config/state directly bypasses the integration layer and defeats the purpose of the test.
 

docs/AGENTS.md

@@ -41,7 +41,8 @@
     "docs:watch": "make docs-watch",
     "storybook": "make storybook",
     "storybook:build": "make storybook-build",
-    "test:storybook": "make test-storybook"
+    "test:storybook": "make test-storybook",
+    "rebuild": "echo \"No native modules to rebuild\""
   },
   "dependencies": {
     "@ai-sdk/anthropic": "^2.0.29",
@@ -69,6 +70,7 @@
     "markdown-it": "^14.1.0",
     "minimist": "^1.2.8",
     "rehype-harden": "^1.1.5",
+    "shescape": "^2.1.6",
     "source-map-support": "^0.5.21",
     "streamdown": "^1.4.0",
     "undici": "^7.16.0",

package.json

@@ -123,6 +123,10 @@ while true; do
     echo "💡 To extract detailed logs from the failed run:"
     echo "   ./scripts/extract_pr_logs.sh $PR_NUMBER"
     echo "   ./scripts/extract_pr_logs.sh $PR_NUMBER <job_pattern>  # e.g., Integration"
+    echo ""
+    echo "💡 To re-run a subset of integration tests faster with workflow_dispatch:"
+    echo "   gh workflow run ci.yml --ref $(git rev-parse --abbrev-ref HEAD) -f test_filter=\"tests/ipcMain/specificTest.test.ts\""
+    echo "   gh workflow run ci.yml --ref $(git rev-parse --abbrev-ref HEAD) -f test_filter=\"-t 'specific test name'\""
     exit 1
   fi
 

scripts/wait_pr_checks.sh

@@ -22,11 +22,13 @@ import { CommandPalette } from "./components/CommandPalette";
 import { buildCoreSources, type BuildSourcesParams } from "./utils/commands/sources";
 
 import type { ThinkingLevel } from "./types/thinking";
+import type { RuntimeConfig } from "./types/runtime";
 import { CUSTOM_EVENTS } from "./constants/events";
 import { isWorkspaceForkSwitchEvent } from "./utils/workspaceFork";
 import { getThinkingLevelKey } from "./constants/storage";
 import type { BranchListResult } from "./types/ipc";
 import { useTelemetry } from "./hooks/useTelemetry";
+import { parseRuntimeString } from "./utils/chatCommands";
 
 const THINKING_LEVELS: ThinkingLevel[] = ["off", "low", "medium", "high"];
 
@@ -233,15 +235,35 @@ function AppInner() {
     [handleRemoveProject]
   );
 
-  const handleCreateWorkspace = async (branchName: string, trunkBranch: string) => {
+  const handleCreateWorkspace = async (
+    branchName: string,
+    trunkBranch: string,
+    runtime?: string
+  ) => {
     if (!workspaceModalProject) return;
 
     console.assert(
       typeof trunkBranch === "string" && trunkBranch.trim().length > 0,
       "Expected trunk branch to be provided by the workspace modal"
     );
 
-    const newWorkspace = await createWorkspace(workspaceModalProject, branchName, trunkBranch);
+    // Parse runtime config if provided
+    let runtimeConfig: RuntimeConfig | undefined;
+    if (runtime) {
+      try {
+        runtimeConfig = parseRuntimeString(runtime, branchName);
+      } catch (err) {
+        console.error("Failed to parse runtime config:", err);
+        throw err; // Let modal handle the error
+      }
+    }
+
+    const newWorkspace = await createWorkspace(
+      workspaceModalProject,
+      branchName,
+      trunkBranch,
+      runtimeConfig
+    );
     if (newWorkspace) {
       // Track workspace creation
       telemetry.workspaceCreated(newWorkspace.workspaceId);
@@ -406,21 +428,6 @@ function AppInner() {
     [handleAddWorkspace]
   );
 
-  const createWorkspaceFromPalette = useCallback(
-    async (projectPath: string, branchName: string, trunkBranch: string) => {
-      console.assert(
-        typeof trunkBranch === "string" && trunkBranch.trim().length > 0,
-        "Expected trunk branch to be provided by the command palette"
-      );
-      const newWs = await createWorkspace(projectPath, branchName, trunkBranch);
-      if (newWs) {
-        telemetry.workspaceCreated(newWs.workspaceId);
-        setSelectedWorkspace(newWs);
-      }
-    },
-    [createWorkspace, setSelectedWorkspace, telemetry]
-  );
-
   const getBranchesForProject = useCallback(
     async (projectPath: string): Promise<BranchListResult> => {
       const branchResult = await window.api.projects.listBranches(projectPath);
@@ -488,7 +495,6 @@ function AppInner() {
     getThinkingLevel: getThinkingLevelForWorkspace,
     onSetThinkingLevel: setThinkingLevelFromPalette,
     onOpenNewWorkspaceModal: openNewWorkspaceFromPalette,
-    onCreateWorkspace: createWorkspaceFromPalette,
     getBranchesForProject,
     onSelectWorkspace: selectWorkspaceFromPalette,
     onRemoveWorkspace: removeWorkspaceFromPalette,

src/App.tsx

@@ -10,9 +10,13 @@ interface NewWorkspaceModalProps {
   defaultTrunkBranch?: string;
   loadErrorMessage?: string | null;
   onClose: () => void;
-  onAdd: (branchName: string, trunkBranch: string) => Promise<void>;
+  onAdd: (branchName: string, trunkBranch: string, runtime?: string) => Promise<void>;
 }
 
+// Shared form field styles
+const formFieldClasses =
+  "[&_label]:text-foreground [&_input]:bg-modal-bg [&_input]:border-border-medium [&_input]:focus:border-accent [&_select]:bg-modal-bg [&_select]:border-border-medium [&_select]:focus:border-accent [&_option]:bg-modal-bg mb-5 [&_input]:w-full [&_input]:rounded [&_input]:border [&_input]:px-3 [&_input]:py-2 [&_input]:text-sm [&_input]:text-white [&_input]:focus:outline-none [&_input]:disabled:cursor-not-allowed [&_input]:disabled:opacity-60 [&_label]:mb-2 [&_label]:block [&_label]:text-sm [&_option]:text-white [&_select]:w-full [&_select]:cursor-pointer [&_select]:rounded [&_select]:border [&_select]:px-3 [&_select]:py-2 [&_select]:text-sm [&_select]:text-white [&_select]:focus:outline-none [&_select]:disabled:cursor-not-allowed [&_select]:disabled:opacity-60";
+
 const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
   isOpen,
   projectName,
@@ -24,6 +28,8 @@ const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
 }) => {
   const [branchName, setBranchName] = useState("");
   const [trunkBranch, setTrunkBranch] = useState(defaultTrunkBranch ?? branches[0] ?? "");
+  const [runtimeMode, setRuntimeMode] = useState<"local" | "ssh">("local");
+  const [sshHost, setSshHost] = useState("");
   const [isLoading, setIsLoading] = useState(false);
   const [error, setError] = useState<string | null>(null);
   const infoId = useId();
@@ -53,6 +59,8 @@ const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
   const handleCancel = () => {
     setBranchName("");
     setTrunkBranch(defaultTrunkBranch ?? branches[0] ?? "");
+    setRuntimeMode("local");
+    setSshHost("");
     setError(loadErrorMessage ?? null);
     onClose();
   };
@@ -74,13 +82,29 @@ const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
     console.assert(normalizedTrunkBranch.length > 0, "Expected trunk branch name to be validated");
     console.assert(trimmedBranchName.length > 0, "Expected branch name to be validated");
 
+    // Validate SSH host if SSH runtime selected
+    if (runtimeMode === "ssh") {
+      const trimmedHost = sshHost.trim();
+      if (trimmedHost.length === 0) {
+        setError("SSH host is required (e.g., hostname or user@host)");
+        return;
+      }
+      // Accept both "hostname" and "user@hostname" formats
+      // SSH will use current user or ~/.ssh/config if user not specified
+    }
+
     setIsLoading(true);
     setError(null);
 
     try {
-      await onAdd(trimmedBranchName, normalizedTrunkBranch);
+      // Build runtime string if SSH selected
+      const runtime = runtimeMode === "ssh" ? `ssh ${sshHost.trim()}` : undefined;
+
+      await onAdd(trimmedBranchName, normalizedTrunkBranch, runtime);
       setBranchName("");
       setTrunkBranch(defaultTrunkBranch ?? branches[0] ?? "");
+      setRuntimeMode("local");
+      setSshHost("");
       onClose();
     } catch (err) {
       const message = err instanceof Error ? err.message : "Failed to create workspace";
@@ -100,7 +124,7 @@ const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
       describedById={infoId}
     >
       <form onSubmit={(event) => void handleSubmit(event)}>
-        <div className="[&_label]:text-foreground [&_input]:bg-modal-bg [&_input]:border-border-medium [&_input]:focus:border-accent [&_select]:bg-modal-bg [&_select]:border-border-medium [&_select]:focus:border-accent [&_option]:bg-modal-bg mb-5 [&_input]:w-full [&_input]:rounded [&_input]:border [&_input]:px-3 [&_input]:py-2 [&_input]:text-sm [&_input]:text-white [&_input]:focus:outline-none [&_input]:disabled:cursor-not-allowed [&_input]:disabled:opacity-60 [&_label]:mb-2 [&_label]:block [&_label]:text-sm [&_option]:text-white [&_select]:w-full [&_select]:cursor-pointer [&_select]:rounded [&_select]:border [&_select]:px-3 [&_select]:py-2 [&_select]:text-sm [&_select]:text-white [&_select]:focus:outline-none [&_select]:disabled:cursor-not-allowed [&_select]:disabled:opacity-60">
+        <div className={formFieldClasses}>
           <label htmlFor="branchName">
             <TooltipWrapper inline>
               <span className="cursor-help underline decoration-[#666] decoration-dotted underline-offset-2">
@@ -137,7 +161,7 @@ const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
           {error && <div className="text-danger-light mt-1.5 text-[13px]">{error}</div>}
         </div>
 
-        <div className="[&_label]:text-foreground [&_input]:bg-modal-bg [&_input]:border-border-medium [&_input]:focus:border-accent [&_select]:bg-modal-bg [&_select]:border-border-medium [&_select]:focus:border-accent [&_option]:bg-modal-bg mb-5 [&_input]:w-full [&_input]:rounded [&_input]:border [&_input]:px-3 [&_input]:py-2 [&_input]:text-sm [&_input]:text-white [&_input]:focus:outline-none [&_input]:disabled:cursor-not-allowed [&_input]:disabled:opacity-60 [&_label]:mb-2 [&_label]:block [&_label]:text-sm [&_option]:text-white [&_select]:w-full [&_select]:cursor-pointer [&_select]:rounded [&_select]:border [&_select]:px-3 [&_select]:py-2 [&_select]:text-sm [&_select]:text-white [&_select]:focus:outline-none [&_select]:disabled:cursor-not-allowed [&_select]:disabled:opacity-60">
+        <div className={formFieldClasses}>
           <label htmlFor="trunkBranch">Trunk Branch:</label>
           {hasBranches ? (
             <select
@@ -173,18 +197,62 @@ const NewWorkspaceModal: React.FC<NewWorkspaceModalProps> = ({
           )}
         </div>
 
+        <div className={formFieldClasses}>
+          <label htmlFor="runtimeMode">Runtime:</label>
+          <select
+            id="runtimeMode"
+            value={runtimeMode}
+            onChange={(event) => {
+              setRuntimeMode(event.target.value as "local" | "ssh");
+              setError(null);
+            }}
+            disabled={isLoading}
+          >
+            <option value="local">Local</option>
+            <option value="ssh">SSH Remote</option>
+          </select>
+        </div>
+
+        {runtimeMode === "ssh" && (
+          <div className={formFieldClasses}>
+            <label htmlFor="sshHost">SSH Host:</label>
+            <input
+              id="sshHost"
+              type="text"
+              value={sshHost}
+              onChange={(event) => {
+                setSshHost(event.target.value);
+                setError(null);
+              }}
+              placeholder="hostname or user@hostname"
+              disabled={isLoading}
+              required
+              aria-required="true"
+            />
+            <div className="text-muted mt-1.5 text-[13px]">
+              Workspace will be created at ~/cmux/{branchName || "<branch-name>"} on remote host
+            </div>
+          </div>
+        )}
+
         <ModalInfo id={infoId}>
           <p>This will create a git worktree at:</p>
           <code className="block break-all">
-            ~/.cmux/src/{projectName}/{branchName || "<branch-name>"}
+            {runtimeMode === "ssh"
+              ? `${sshHost || "<host>"}:~/cmux/${branchName || "<branch-name>"}`
+              : `~/.cmux/src/${projectName}/${branchName || "<branch-name>"}`}
           </code>
         </ModalInfo>
 
         {branchName.trim() && (
           <div>
             <div className="text-muted mb-2 font-sans text-xs">Equivalent command:</div>
             <div className="bg-dark border-border-light text-light mt-5 rounded border p-3 font-mono text-[13px] break-all whitespace-pre-wrap">
-              {formatNewCommand(branchName.trim(), trunkBranch.trim() || undefined)}
+              {formatNewCommand(
+                branchName.trim(),
+                trunkBranch.trim() || undefined,
+                runtimeMode === "ssh" && sshHost.trim() ? `ssh ${sshHost.trim()}` : undefined
+              )}
             </div>
           </div>
         )}

src/components/NewWorkspaceModal.tsx

@@ -129,24 +129,6 @@ export class Config {
    * Get the workspace worktree path for a given directory name.
    * The directory name is the workspace name (branch name).
    */
-  getWorkspacePath(projectPath: string, directoryName: string): string {
-    const projectName = this.getProjectName(projectPath);
-    return path.join(this.srcDir, projectName, directoryName);
-  }
-
-  /**
-   * Compute workspace path from metadata.
-   * Directory uses workspace name (e.g., ~/.cmux/src/project/workspace-name).
-   */
-  getWorkspacePaths(metadata: WorkspaceMetadata): {
-    /** Worktree path (uses workspace name as directory) */
-    namedWorkspacePath: string;
-  } {
-    const path = this.getWorkspacePath(metadata.projectPath, metadata.name);
-    return {
-      namedWorkspacePath: path,
-    };
-  }
 
   /**
    * Add paths to WorkspaceMetadata to create FrontendWorkspaceMetadata.
@@ -274,6 +256,8 @@ export class Config {
               projectPath,
               // GUARANTEE: All workspaces must have createdAt (assign now if missing)
               createdAt: workspace.createdAt ?? new Date().toISOString(),
+              // Include runtime config if present (for SSH workspaces)
+              runtimeConfig: workspace.runtimeConfig,
             };
 
             // Migrate missing createdAt to config for next load
@@ -383,7 +367,10 @@ export class Config {
       // Check if workspace already exists (by ID)
       const existingIndex = project.workspaces.findIndex((w) => w.id === metadata.id);
 
-      const workspacePath = this.getWorkspacePath(projectPath, metadata.name);
+      // Compute workspace path - this is only for legacy config migration
+      // New code should use Runtime.getWorkspacePath() directly
+      const projectName = this.getProjectName(projectPath);
+      const workspacePath = path.join(this.srcDir, projectName, metadata.name);
       const workspaceEntry: Workspace = {
         path: workspacePath,
         id: metadata.id,

src/config.ts

@@ -0,0 +1,14 @@
+/**
+ * Standard environment variables for non-interactive command execution.
+ * These prevent tools from blocking on editor/credential prompts.
+ */
+export const NON_INTERACTIVE_ENV_VARS = {
+  // Prevent interactive editors from blocking execution
+  // Critical for git operations like rebase/commit that try to open editors
+  GIT_EDITOR: "true", // Git-specific editor (highest priority)
+  GIT_SEQUENCE_EDITOR: "true", // For interactive rebase sequences
+  EDITOR: "true", // General fallback for non-git commands
+  VISUAL: "true", // Another common editor environment variable
+  // Prevent git from prompting for credentials
+  GIT_TERMINAL_PROMPT: "0", // Disables git credential prompts
+} as const;