|
1 | 1 | # Getting Started |
2 | 2 |
|
3 | | -## Installation |
| 3 | +## Downloads |
4 | 4 |
|
5 | | -### Prerequisites |
| 5 | +### Development Builds |
6 | 6 |
|
7 | | -- [Bun](https://bun.sh) - JavaScript runtime and package manager |
8 | | -- Git |
| 7 | +Pre-built binaries are available from [GitHub Actions](https://github.com/coder/cmux/actions/workflows/build.yml): |
9 | 8 |
|
10 | | -### Clone and Install |
| 9 | +- **macOS**: Universal binary DMG (Intel + Apple Silicon) |
| 10 | +- **Linux**: AppImage (portable, works on most distros) |
11 | 11 |
|
12 | | -```bash |
13 | | -git clone https://github.com/ammarbandukwala/cmux.git |
14 | | -cd cmux |
15 | | -bun install |
16 | | -``` |
| 12 | +To download: |
17 | 13 |
|
18 | | -## Development |
| 14 | +1. Go to the [Build workflow](https://github.com/coder/cmux/actions/workflows/build.yml) |
| 15 | +2. Click on the latest successful run |
| 16 | +3. Scroll down to "Artifacts" section |
| 17 | +4. Download `macos-dmg` or `linux-appimage` |
19 | 18 |
|
20 | | -```bash |
21 | | -# Start development server |
22 | | -bun dev |
| 19 | +### Installation |
23 | 20 |
|
24 | | -# In another terminal, start Electron |
25 | | -bun start |
26 | | -``` |
| 21 | +**macOS:** |
27 | 22 |
|
28 | | -## Building |
| 23 | +⚠️ **Note**: The app is unsigned, so you'll need to bypass Gatekeeper security. |
29 | 24 |
|
30 | | -```bash |
31 | | -# Build the application |
32 | | -bun run build |
| 25 | +1. Download and open the DMG file |
| 26 | +2. Drag Cmux to Applications folder |
| 27 | +3. **First time opening**: |
| 28 | + - Don't double-click the app (macOS will block it) |
| 29 | + - Right-click (or Control+click) on Cmux.app |
| 30 | + - Select "Open" from the menu |
| 31 | + - Click "Open" in the security dialog |
| 32 | + - The app will now be allowed to run |
33 | 33 |
|
34 | | -# Package for distribution |
35 | | -bun run dist:mac # macOS |
36 | | -bun run dist:linux # Linux |
37 | | -``` |
| 34 | +**Alternative method if the above doesn't work:** |
38 | 35 |
|
39 | | -## Configuration |
| 36 | +1. After step 2, open Terminal |
| 37 | +2. Run: `xattr -cr /Applications/Cmux.app` |
| 38 | +3. Run: `codesign --force --deep --sign - /Applications/Cmux.app` |
| 39 | +4. Now you can open the app normally |
40 | 40 |
|
41 | | -Configuration is stored in `~/.cmux/config.json` and includes: |
| 41 | +These steps are only needed once. After that, you can open the app normally. |
42 | 42 |
|
43 | | -- Active projects |
44 | | -- Workspace settings |
45 | | -- UI preferences |
| 43 | +**Linux:** |
| 44 | + |
| 45 | +1. Download the AppImage file |
| 46 | +2. Make it executable: `chmod +x Cmux-*.AppImage` |
| 47 | +3. Run it: `./Cmux-*.AppImage` |
0 commit comments