Skip to content

🤖 docs: add Windows installation instructions #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
deansheather merged 1 commit into from
Dec 4, 2025
Merged

🤖 docs: add Windows installation instructions #890

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,19 @@ Download pre-built binaries from [the releases page](https://github.com/coder/mu

- **macOS**: Signed and notarized DMG (separate builds for Intel/Apple Silicon)
- **Linux**: AppImage
- **Windows**: Installer exe

### Development Builds

Down pre-built binaries of `main` from [GitHub Actions](https://github.com/coder/mux/actions/workflows/build.yml):
Download pre-built binaries of `main` from [GitHub Actions](https://github.com/coder/mux/actions/workflows/build.yml):

- **macOS**: Signed and notarized DMG
- `macos-dmg-x64` (Intel Macs)
- `macos-dmg-arm64` (Apple Silicon)
- **Linux**: AppImage (portable, works on most distros)

> **Note**: Windows builds are only available from [releases](https://github.com/coder/mux/releases), not from development builds.

To download:

1. Go to the [Build workflow](https://github.com/coder/mux/actions/workflows/build.yml?query=event:merge_group)
Expand All @@ -44,6 +47,13 @@ The app is code-signed and notarized by Apple, so it will open without security
2. Make it executable: `chmod +x Mux-*.AppImage`
3. Run it: `./Mux-*.AppImage`

**Windows:**

1. Download the installer exe from [releases](https://github.com/coder/mux/releases) (e.g., `mux-x.x.x-x64.exe`)
2. Run the installer
3. Follow the installation prompts
4. Launch Mux from the Start menu or desktop shortcut

### Testing Pre-Release Builds

⚠️ **Note**: Only builds from the `main` branch are signed and notarized. If you're testing a build from a pull request or other branch, you'll need to bypass macOS Gatekeeper:
Expand Down