2020-05-30 20:30:32 +03:00
## Installing on macOS
2021-02-03 22:24:41 +03:00
The CI system builds the package on macOS Big Sur and should run on systems as
"old" as Mojave. It may run on earlier versions of macOS, but that has not
been tested.
2020-05-30 20:30:32 +03:00
2021-02-03 22:24:41 +03:00
Starting with version 20210203-095643-70a364eb, WezTerm is a Universal binary
with support for both Apple Silicon and Intel hardware.
2021-01-13 08:12:54 +03:00
2023-03-16 05:22:51 +03:00
[:simple-apple: Download for macOS :material-tray-arrow-down: ]({{ macos_zip_stable }} ){ .md-button }
[:simple-apple: Nightly for macOS :material-tray-arrow-down: ]({{ macos_zip_nightly }} ){ .md-button }
2023-02-19 00:21:38 +03:00
1. Download < a href = "{{ macos_zip_stable }}" > Release</ a > .
2. Extract the zipfile and drag the `WezTerm.app` bundle to your `Applications` folder.
2020-05-30 20:30:32 +03:00
3. First time around, you may need to right click and select `Open` to allow launching
2023-02-19 00:21:38 +03:00
the application that you've just downloaded from the internet.
3. Subsequently, a simple double-click will launch the UI.
2022-11-19 19:44:28 +03:00
4. To use wezterm binary from a terminal emulator, like `wezterm ls-fonts` you'll need to add the location to the wezterm binary folder that exists _inside_ the WezTerm.app, to your environment's $PATH value. For example, to add it to your `~/.zshrc` file, and assuming your WezTerm.app was installed to `/Applications` , add:
```sh
PATH="$PATH:/Applications/WezTerm.app/Contents/MacOS"
export PATH
```
2023-03-16 05:22:51 +03:00
5. Configuration instructions can be [found here ](../config/files.md )
2020-05-30 20:30:32 +03:00
2020-06-08 00:45:45 +03:00
## Homebrew
2023-02-19 00:21:38 +03:00
WezTerm is available for [brew ](https://brew.sh/ ) users:
2020-06-08 00:45:45 +03:00
2023-03-16 05:22:51 +03:00
```console
2023-02-19 00:21:38 +03:00
$ brew install --cask wezterm
2020-06-08 00:45:45 +03:00
```
2020-05-30 20:30:32 +03:00
2021-05-22 18:30:10 +03:00
If you'd like to use a nightly build:
2020-06-12 07:05:55 +03:00
2023-03-16 05:22:51 +03:00
```console
2024-07-15 16:10:26 +03:00
$ brew install --cask wezterm@nightly
2020-06-12 07:05:55 +03:00
```
2020-10-31 08:32:59 +03:00
2024-07-15 16:10:26 +03:00
!!! note
For users who have previously used the cask named `wezterm-nightly` ,
homebrew has started issuing warnings: `Warning: Cask
homebrew/cask-versions/wezterm-nightly was renamed to wezterm@nightly`. We
recommend that you use `brew uninstall wezterm-nightly` to uninstall the
previously installed version, and then reinstall the new version using the
command above.
2022-01-04 13:59:36 +03:00
to upgrade to a newer nightly (normal `brew upgrade` will not upgrade it!):
2020-10-31 08:32:59 +03:00
2023-03-16 05:22:51 +03:00
```console
2024-07-15 16:10:26 +03:00
$ brew upgrade --cask wezterm@nightly --no-quarantine --greedy-latest
2020-10-31 08:32:59 +03:00
```
2021-04-07 19:35:52 +03:00
2024-07-15 16:10:26 +03:00
!!! note
The `--greedy-latest` option in Homebrew forces the latest version of a
formula to be installed, even if a version satisfying the formula's
requirements is already installed. This can be useful when you want to
ensure you have the most up-to-date version of a package, regardless of
whether an older version meets the current dependency requirements.
2021-04-07 19:35:52 +03:00
## MacPorts
2021-04-07 20:36:03 +03:00
WezTerm is also available via [MacPorts ](https://ports.macports.org/port/wezterm/summary ):
2021-04-07 19:35:52 +03:00
2023-03-16 05:22:51 +03:00
```console
2021-04-07 19:35:52 +03:00
$ sudo port selfupdate
$ sudo port install wezterm
```
2022-11-19 19:44:28 +03:00