registry/registry/coder/modules/mux/README.md

display_name	description	icon	verified	tags
Mux	Coding Agent Multiplexer - Run multiple AI agents in parallel	../../../../.icons/mux.svg	true	ai agents development multiplexer

Mux

Automatically install and run Mux in a Coder workspace. By default, the module auto-detects an available package manager (npm, pnpm, or bun) to install mux@next (with a fallback to downloading the npm tarball if none is found). You can also force a specific package manager via package_manager and point to a custom registry with registry_url. The launcher keeps watching the mux process after startup, appends signal/exit-code diagnostics to the mux log when the server is killed outside the Node runtime, and can optionally wait a few seconds, remove the stale server lock, and restart Mux after any exit until an optional restart-attempt cap is reached. Mux is a desktop application for parallel agentic development that enables developers to run multiple AI agents simultaneously across isolated workspaces.

module "mux" {
  count    = data.coder_workspace.me.start_count
  source   = "registry.coder.com/coder/mux/coder"
  version  = "1.4.3"
  agent_id = coder_agent.main.id
}

Features

• Parallel Agent Execution: Run multiple AI agents simultaneously on different tasks
• Mux Workspace Isolation: Each agent works in its own isolated environment
• Git Divergence Visualization: Track changes across different Mux agent workspaces
• Long-Running Processes: Resume AI work after interruptions
• Cost Tracking: Monitor API usage across agents

Examples

Basic Usage

module "mux" {
  count    = data.coder_workspace.me.start_count
  source   = "registry.coder.com/coder/mux/coder"
  version  = "1.4.3"
  agent_id = coder_agent.main.id
}

Pin Version

module "mux" {
  count    = data.coder_workspace.me.start_count
  source   = "registry.coder.com/coder/mux/coder"
  version  = "1.4.3"
  agent_id = coder_agent.main.id
  # Default is "latest"; set to a specific version to pin
  install_version = "0.4.0"
}

Open a Project on Launch

Start Mux with mux server --add-project /path/to/project:

module "mux" {
  count       = data.coder_workspace.me.start_count
  source      = "registry.coder.com/coder/mux/coder"
  version     = "1.4.3"
  agent_id    = coder_agent.main.id
  add_project = "/path/to/project"
}

Pass Arbitrary mux server Arguments

Use additional_arguments to append additional arguments to mux server. The module parses quoted values, so grouped arguments remain intact.

module "mux" {
  count                = data.coder_workspace.me.start_count
  source               = "registry.coder.com/coder/mux/coder"
  version              = "1.4.3"
  agent_id             = coder_agent.main.id
  additional_arguments = "--open-mode pinned --add-project '/workspaces/my repo'"
}

Restart After Mux Exits

Enable automatic restarts after Mux exits, including clean exits and intentional shutdown signals such as SIGTERM. The launcher waits for restart_delay_seconds, removes ~/.mux/server.lock, and starts Mux again. Set max_restart_attempts to a whole number to stop retrying after a fixed number of restarts, or leave it at 0 for unlimited retries.

module "mux" {
  count                 = data.coder_workspace.me.start_count
  source                = "registry.coder.com/coder/mux/coder"
  version               = "1.4.3"
  agent_id              = coder_agent.main.id
  restart_on_kill       = true
  restart_delay_seconds = 3
  max_restart_attempts  = 5
}

Custom Port

module "mux" {
  count    = data.coder_workspace.me.start_count
  source   = "registry.coder.com/coder/mux/coder"
  version  = "1.4.3"
  agent_id = coder_agent.main.id
  port     = 8080
}

Custom Package Manager

Force a specific package manager instead of auto-detection:

module "mux" {
  count           = data.coder_workspace.me.start_count
  source          = "registry.coder.com/coder/mux/coder"
  version         = "1.4.3"
  agent_id        = coder_agent.main.id
  package_manager = "pnpm" # or "npm", "bun"
}

Custom Registry

Use a private or mirrored npm registry:

module "mux" {
  count        = data.coder_workspace.me.start_count
  source       = "registry.coder.com/coder/mux/coder"
  version      = "1.4.3"
  agent_id     = coder_agent.main.id
  registry_url = "https://npm.pkg.github.com"
}

Use Cached Installation

Run an existing copy of Mux if found, otherwise install from npm:

module "mux" {
  count      = data.coder_workspace.me.start_count
  source     = "registry.coder.com/coder/mux/coder"
  version    = "1.4.3"
  agent_id   = coder_agent.main.id
  use_cached = true
}

Skip Install

Run without installing from the network (requires Mux to be pre-installed):

module "mux" {
  count    = data.coder_workspace.me.start_count
  source   = "registry.coder.com/coder/mux/coder"
  version  = "1.4.3"
  agent_id = coder_agent.main.id
  install  = false
}

Supported Platforms

• Linux (x86_64, aarch64)

Notes

• Mux is currently in preview and you may encounter bugs
• Requires internet connectivity for agent operations (unless install is set to false)
• Auto-detects npm, pnpm, or bun by default; set package_manager to force a specific one
• Installs mux@next from the npm registry by default; set registry_url to use a private or mirrored registry
• Falls back to a direct tarball download when no package manager is found
• Appends best-effort signal and external-kill diagnostics to log_path if the mux process dies after startup
• Set restart_on_kill = true to wait restart_delay_seconds, remove ~/.mux/server.lock, and restart Mux after it exits
• Set max_restart_attempts to a whole-number cap on restart attempts, or leave it at 0 for unlimited retries