9817d131f8
* Rename cmuxterm to cmux across entire codebase - Rename GitHub repos: manaflow-ai/cmuxterm -> manaflow-ai/cmux, manaflow-ai/homebrew-cmuxterm -> manaflow-ai/homebrew-cmux - Rename bundle IDs: com.cmuxterm.app -> com.cmux.app - Rename CLI: CLI/cmuxterm.swift -> CLI/cmux.swift - Rename homebrew submodule: homebrew-cmuxterm -> homebrew-cmux - Update all socket paths: /tmp/cmuxterm*.sock -> /tmp/cmux*.sock - Update all GitHub URLs, DMG names, Sparkle URLs - Update all source files, scripts, tests, docs, CI workflows * Bump version to 1.23.0
70 lines
1.6 KiB
Text
70 lines
1.6 KiB
Text
---
|
|
title: Installation
|
|
description: How to install cmux on macOS
|
|
---
|
|
|
|
# Installation
|
|
|
|
## Homebrew (Recommended)
|
|
|
|
Install via Homebrew:
|
|
|
|
```bash
|
|
brew tap manaflow-ai/cmux
|
|
brew install --cask cmux
|
|
```
|
|
|
|
To update later:
|
|
|
|
```bash
|
|
brew upgrade --cask cmux
|
|
```
|
|
|
|
## Manual Download
|
|
|
|
Download the latest release from GitHub:
|
|
|
|
<a href="https://github.com/manaflow-ai/cmux/releases/latest/download/cmux-macos.dmg">
|
|
<img src="/macos-badge.png" alt="Download cmux for macOS" width="180" />
|
|
</a>
|
|
|
|
Then:
|
|
|
|
1. Open the downloaded `.dmg` file
|
|
2. Drag **cmux** to your **Applications** folder
|
|
3. Open cmux from Applications
|
|
|
|
<Callout type="info">
|
|
On first launch, macOS may ask you to confirm opening an app from an identified developer. Click **Open** to proceed.
|
|
</Callout>
|
|
|
|
## Verify Installation
|
|
|
|
Open cmux and you should see:
|
|
|
|
- A terminal window with a vertical tab sidebar on the left
|
|
- One initial tab already open
|
|
- The Ghostty-powered terminal ready for input
|
|
|
|
## CLI Tool
|
|
|
|
cmux includes a command-line tool for automation. It's bundled inside the app and works automatically when you run commands inside cmux.
|
|
|
|
To use the CLI from outside cmux, you can create a symlink:
|
|
|
|
```bash
|
|
sudo ln -sf "/Applications/cmux.app/Contents/MacOS/cmux" /usr/local/bin/cmux
|
|
```
|
|
|
|
Then you can run commands like:
|
|
|
|
```bash
|
|
cmux list-tabs
|
|
cmux notify --title "Build Complete" --body "Your build finished successfully"
|
|
```
|
|
|
|
## Updates
|
|
|
|
cmux checks for updates automatically using Sparkle. When an update is available, you'll see an update pill in the titlebar. Click it to install the latest version.
|
|
|
|
You can also check for updates manually via **cmux → Check for Updates** in the menu bar.
|