> ## Documentation Index
> Fetch the complete documentation index at: https://xum.cdr.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Install

> Download and install Xum for macOS, Linux, and Windows

## Downloads

### Release Builds

<Card title="Download Xum" icon="download" href="/web-api/iframe-proxy?url=https://github.com/coder/mux/releases">
  Download pre-built binaries from the releases page.
</Card>

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

### Development Builds

Download pre-built binaries of `main` from [GitHub Actions](https://github.com/coder/mux/actions/workflows/pr.yml?query=event:push+branch:main):

* **macOS**: Signed and notarized DMG
  * `build-macos-x64` (Intel Macs)
  * `build-macos-arm64` (Apple Silicon)
* **Linux**: `build-linux` AppImage (portable, works on most distros)
* **Windows**: `build-windows` installer exe

To download:

1. Go to the [PR workflow (main branch)](https://github.com/coder/mux/actions/workflows/pr.yml?query=event:push+branch:main)
2. Click on the latest successful run
3. Scroll down to "Artifacts" section
4. Download the appropriate artifact for your platform

### Installation

#### macOS

1. Download the DMG file for your Mac:
   * Intel Mac: `macos-dmg-x64`
   * Apple Silicon: `macos-dmg-arm64`
2. Open the DMG file
3. Drag Xum to Applications folder
4. Open the app normally

The app is code-signed and notarized by Apple, so it will open without security warnings.

#### Linux

1. Download the AppImage file
2. Make it executable: `chmod +x xum-*.AppImage`
3. Run it: `./xum-*.AppImage`

#### Windows

*(alpha)*

Prerequisites:

* Install **Git for Windows** (includes Git Bash). **WSL is not supported.**
* Restart Xum after installing Git for Windows.

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

<Warning>
  Windows support is currently in alpha. Please [report any
  issues](https://github.com/coder/mux/issues) you encounter.
</Warning>

### Testing Pre-Release Builds

<Warning>
  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:
</Warning>

1. After installing, open Terminal
2. Run: `xattr -cr /Applications/xum.app`
3. Run: `codesign --force --deep --sign - /Applications/xum.app`
4. Now you can open the app normally

## Nix and NixOS

The repository is a Nix flake. To try Xum without installing it:

```bash theme={null}
nix run github:coder/mux
```

The flake builds on Linux and on Apple silicon Macs. It does not build on Intel Macs, because current nixpkgs has dropped them. On an Intel Mac, use the [macOS download](#macos) instead.

To install it, add the flake as an input of your own flake:

```nix theme={null}
inputs.xum = {
  url = "github:coder/mux";
  inputs.nixpkgs.follows = "nixpkgs";
};
```

Then add the overlay and the package to a NixOS module (this example passes `inputs` through `specialArgs`):

```nix theme={null}
nixpkgs.overlays = [ inputs.xum.overlays.default ];
environment.systemPackages = [ pkgs.xum ];
```

The overlay builds Xum with your nixpkgs, so Electron uses the same glibc as your graphics drivers. It needs a nixpkgs that has `electron_44`, such as `nixos-unstable`. With the overlay, `inputs.nixpkgs.follows` only keeps a second copy of nixpkgs out of your `flake.lock`. On an older nixpkgs, remove `inputs.nixpkgs.follows` and use `inputs.xum.packages.${pkgs.stdenv.hostPlatform.system}.default` instead.

If the window stays on the loading screen, start Xum with `xum --disable-gpu`.

## CLI via npm

The Xum CLI can also be run directly via `npx` without installing the desktop app:

```bash theme={null}
# Run agent tasks
npx @coder/xum run "Fix the failing tests"

# Start the server for remote/mobile access
npx @coder/xum server --port 3000
```

Or install globally:

```bash theme={null}
npm install -g @coder/xum
```

The legacy `mux` package and command forward to the matching Xum release during the transition. See [Mux compatibility](/reference/mux-compatibility) for storage, environment-variable, and downgrade details.

This is ideal for CI/CD pipelines and scripted automation. See the [CLI documentation](/reference/cli) for all available commands and options.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.