Skip to content

Commit 0e3263f

Browse files
authored
fix: change cmux npm package to mux (#533)
1 parent f304201 commit 0e3263f

File tree

7 files changed

+262
-191
lines changed

7 files changed

+262
-191
lines changed
File renamed without changes.

registry/coder/modules/cmux/run.sh

Lines changed: 0 additions & 135 deletions
This file was deleted.
Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
display_name: cmux
2+
display_name: mux
33
description: Coding Agent Multiplexer - Run multiple AI agents in parallel
4-
icon: ../../../../.icons/cmux.svg
4+
icon: ../../../../.icons/mux.svg
55
verified: false
66
tags: [ai, agents, development, multiplexer]
77
---
88

9-
# cmux
9+
# mux
1010

11-
Automatically install and run [cmux](https://github.com/coder/cmux) in a Coder workspace. By default, the module installs `@coder/cmux@latest` from npm (with a fallback to downloading the npm tarball if npm is unavailable). cmux is a desktop application for parallel agentic development that enables developers to run multiple AI agents simultaneously across isolated cmux workspaces.
11+
Automatically install and run mux in a Coder workspace. By default, the module installs `mux@next` from npm (with a fallback to downloading the npm tarball if npm is unavailable). mux is a desktop application for parallel agentic development that enables developers to run multiple AI agents simultaneously across isolated workspaces.
1212

1313
```tf
14-
module "cmux" {
14+
module "mux" {
1515
count = data.coder_workspace.me.start_count
16-
source = "registry.coder.com/coder/cmux/coder"
17-
version = "1.0.2"
16+
source = "registry.coder.com/coder/mux/coder"
17+
version = "1.0.0"
1818
agent_id = coder_agent.example.id
1919
}
2020
```
2121

2222
## Features
2323

2424
- **Parallel Agent Execution**: Run multiple AI agents simultaneously on different tasks
25-
- **Cmux Workspace Isolation**: Each agent works in its own isolated environment
26-
- **Git Divergence Visualization**: Track changes across different cmux agent workspaces
25+
- **Mux Workspace Isolation**: Each agent works in its own isolated environment
26+
- **Git Divergence Visualization**: Track changes across different mux agent workspaces
2727
- **Long-Running Processes**: Resume AI work after interruptions
2828
- **Cost Tracking**: Monitor API usage across agents
2929

@@ -32,21 +32,21 @@ module "cmux" {
3232
### Basic Usage
3333

3434
```tf
35-
module "cmux" {
35+
module "mux" {
3636
count = data.coder_workspace.me.start_count
37-
source = "registry.coder.com/coder/cmux/coder"
38-
version = "1.0.2"
37+
source = "registry.coder.com/coder/mux/coder"
38+
version = "1.0.0"
3939
agent_id = coder_agent.example.id
4040
}
4141
```
4242

4343
### Pin Version
4444

4545
```tf
46-
module "cmux" {
46+
module "mux" {
4747
count = data.coder_workspace.me.start_count
48-
source = "registry.coder.com/coder/cmux/coder"
49-
version = "1.0.2"
48+
source = "registry.coder.com/coder/mux/coder"
49+
version = "1.0.0"
5050
agent_id = coder_agent.example.id
5151
# Default is "latest"; set to a specific version to pin
5252
install_version = "0.4.0"
@@ -56,38 +56,38 @@ module "cmux" {
5656
### Custom Port
5757

5858
```tf
59-
module "cmux" {
59+
module "mux" {
6060
count = data.coder_workspace.me.start_count
61-
source = "registry.coder.com/coder/cmux/coder"
62-
version = "1.0.2"
61+
source = "registry.coder.com/coder/mux/coder"
62+
version = "1.0.0"
6363
agent_id = coder_agent.example.id
6464
port = 8080
6565
}
6666
```
6767

6868
### Use Cached Installation
6969

70-
Run an existing copy of cmux if found, otherwise install from npm:
70+
Run an existing copy of mux if found, otherwise install from npm:
7171

7272
```tf
73-
module "cmux" {
73+
module "mux" {
7474
count = data.coder_workspace.me.start_count
75-
source = "registry.coder.com/coder/cmux/coder"
76-
version = "1.0.2"
75+
source = "registry.coder.com/coder/mux/coder"
76+
version = "1.0.0"
7777
agent_id = coder_agent.example.id
7878
use_cached = true
7979
}
8080
```
8181

8282
### Skip Install
8383

84-
Run without installing from the network (requires cmux to be pre-installed):
84+
Run without installing from the network (requires mux to be pre-installed):
8585

8686
```tf
87-
module "cmux" {
87+
module "mux" {
8888
count = data.coder_workspace.me.start_count
89-
source = "registry.coder.com/coder/cmux/coder"
90-
version = "1.0.2"
89+
source = "registry.coder.com/coder/mux/coder"
90+
version = "1.0.0"
9191
agent_id = coder_agent.example.id
9292
install = false
9393
}
@@ -99,6 +99,6 @@ module "cmux" {
9999

100100
## Notes
101101

102-
- cmux is currently in preview and you may encounter bugs
102+
- mux is currently in preview and you may encounter bugs
103103
- Requires internet connectivity for agent operations (unless `install` is set to false)
104-
- Installs `@coder/cmux` from npm by default (falls back to the npm tarball if npm is unavailable)
104+
- Installs `mux@next` from npm by default (falls back to the npm tarball if npm is unavailable)

registry/coder/modules/cmux/main.test.ts renamed to registry/coder/modules/mux/main.test.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {
66
testRequiredVariables,
77
} from "~test";
88

9-
describe("cmux", async () => {
9+
describe("mux", async () => {
1010
await runTerraformInit(import.meta.dir);
1111

1212
testRequiredVariables(import.meta.dir, {
@@ -31,9 +31,9 @@ describe("cmux", async () => {
3131
expect(output.exitCode).toBe(0);
3232
const expectedLines = [
3333
"📥 npm not found; downloading tarball from npm registry...",
34-
"🥳 cmux has been installed in /tmp/cmux",
35-
"🚀 Starting cmux server on port 4000...",
36-
"Check logs at /tmp/cmux.log!",
34+
"🥳 mux has been installed in /tmp/mux",
35+
"🚀 Starting mux server on port 4000...",
36+
"Check logs at /tmp/mux.log!",
3737
];
3838
for (const line of expectedLines) {
3939
expect(output.stdout).toContain(line);
@@ -54,10 +54,10 @@ describe("cmux", async () => {
5454

5555
expect(output.exitCode).toBe(0);
5656
const expectedLines = [
57-
"📦 Installing @coder/cmux via npm into /tmp/cmux...",
58-
"🥳 cmux has been installed in /tmp/cmux",
59-
"🚀 Starting cmux server on port 4000...",
60-
"Check logs at /tmp/cmux.log!",
57+
"📦 Installing mux via npm into /tmp/mux...",
58+
"🥳 mux has been installed in /tmp/mux",
59+
"🚀 Starting mux server on port 4000...",
60+
"Check logs at /tmp/mux.log!",
6161
];
6262
for (const line of expectedLines) {
6363
expect(output.stdout).toContain(line);

0 commit comments

Comments
 (0)