2022-08-09 16:50:46 +03:00
## Installing on Linux via Flathub
WezTerm is available in flatpak format and published on
[Flathub ](https://flathub.org/apps/details/org.wezfurlong.wezterm ), which is
aggregated into the GNOME Software application and other similar
storefront/software catalog applications.
< a href = 'https://flathub.org/apps/details/org.wezfurlong.wezterm' > < img width = '240' alt = 'Download on Flathub' src = 'https://flathub.org/assets/badges/flathub-badge-en.png' / > < / a >
To install using the command line:
First, [setup flatpak on your system ](https://flatpak.org/setup/ ), then:
2023-03-16 05:22:51 +03:00
```console
$ flatpak install flathub org.wezfurlong.wezterm
2022-08-09 16:50:46 +03:00
```
and then run:
2023-03-16 05:22:51 +03:00
```console
$ flatpak run org.wezfurlong.wezterm
2022-08-09 16:50:46 +03:00
```
You may wish to define an alias for convenience:
2023-03-16 05:22:51 +03:00
```console
$ alias wezterm='flatpak run org.wezfurlong.wezterm'
2022-08-09 16:50:46 +03:00
```
2023-04-18 04:15:27 +03:00
!!! note
flatpaks run in an isolated sandbox so some functionality may behave a little
differently when compared to installing the native package format for your
system.
* starting wezterm using `wezterm cli` subcommands will block on the first
run since you logged in if you haven't already launched the gui.
* Process inspection functions such as determining the current directory
for a pane will not work
The flatpak is provided primarily for ease of trying out wezterm with
low commitment, and you are encouraged to use native packages for your
system once you're ready to get the most out of wezterm.
2022-08-09 16:50:46 +03:00
Only stable releases are allowed to be published to Flathub, so if
you want/need to try a nightly download you will need to use one of
the other options below.
2020-05-30 20:30:32 +03:00
## Installing on Linux using AppImage
WezTerm is available in [AppImage ](https://appimage.org/ ) format; a
self-contained single file that doesn't require installation or
2020-06-08 00:45:45 +03:00
any special privileges to run, and that is compatible with a wide
range of Linux distributions.
2020-05-30 20:30:32 +03:00
Download and make the file executable and you're ready to run!
2023-03-21 03:54:30 +03:00
[AppImage :material-tray-arrow-down: ]({{ ubuntu20_AppImage_stable }} ){ .md-button }
[Nightly AppImage :material-tray-arrow-down: ]({{ ubuntu20_AppImage_nightly }} ){ .md-button }
2020-05-30 20:30:32 +03:00
2023-03-16 05:22:51 +03:00
```console
2023-03-21 03:54:30 +03:00
$ curl -LO {{ ubuntu20_AppImage_stable }}
$ chmod +x {{ ubuntu20_AppImage_stable_asset }}
2020-05-30 20:30:32 +03:00
```
You may then execute the appimage directly to launch wezterm, with no
specific installation steps required:
2023-03-16 05:22:51 +03:00
```console
2023-03-21 03:54:30 +03:00
$ ./{{ ubuntu20_AppImage_stable_asset }}
2020-05-30 20:30:32 +03:00
```
That said, you may wish to make it a bit more convenient:
2023-03-16 05:22:51 +03:00
```console
$ mkdir ~/bin
2023-03-21 03:54:30 +03:00
$ mv ./{{ ubuntu20_AppImage_stable_asset }} ~/bin/wezterm
2023-03-16 05:22:51 +03:00
$ ~/bin/wezterm
2020-05-30 20:30:32 +03:00
```
2023-03-16 05:22:51 +03:00
* Configuration instructions can be [found here ](../config/files.md )
2020-05-30 20:30:32 +03:00
2024-01-11 03:07:38 +03:00
## Installing on Ubuntu
Nightly builds are now available in a hosted APT repo. You can configure your system to
use that APT repo by following these steps:
```console
$ curl -fsSL https://apt.fury.io/wez/gpg.key | sudo gpg --yes --dearmor -o /usr/share/keyrings/wezterm-fury.gpg
2024-01-11 17:36:35 +03:00
$ echo 'deb [signed-by=/usr/share/keyrings/wezterm-fury.gpg] https://apt.fury.io/wez/ * * ' | sudo tee /etc/apt/sources.list.d/wezterm.list
2024-01-11 03:07:38 +03:00
```
Now you can install wezterm:
```console
$ sudo apt install wezterm-nightly
```
2020-05-30 20:30:32 +03:00
## Installing on Ubuntu and Debian-based Systems
The CI system builds `.deb` files for a variety of Ubuntu and Debian distributions.
These are often compatible with other Debian style systems; if you don't find one
that exactly matches your system you can try installing one from an older version
of your distribution, or use one of the Debian packages linked below. Failing that,
you can try the AppImage download which should work on most Linux systems.
2023-10-04 20:27:30 +03:00
|Distro | Stable | Nightly| |
|------------|------------------|--------|------------|
|Ubuntu20 |[amd64]({{ ubuntu20_deb_stable }}) |[amd64]({{ ubuntu20_deb_nightly }})| |
|Ubuntu22 |[amd64]({{ ubuntu22_deb_stable }}) |[amd64]({{ ubuntu22_deb_nightly }})|[arm64]({{ ubuntu22_arm64_deb_nightly}})|
|Debian10 |[amd64]({{ debian10_deb_stable }}) |[amd64]({{ debian10_deb_nightly }})| |
|Debian11 |[amd64]({{ debian11_deb_stable }}) |[amd64]({{ debian11_deb_nightly }})| |
2023-10-04 21:31:17 +03:00
|Debian12 |Nightly builds only|[amd64]({{ debian12_deb_nightly }})|[arm64]({{ debian12_arm64_deb_nightly }}) |
2020-05-30 20:30:32 +03:00
To download and install from the CLI, you can use something like this, which
2022-06-27 20:54:09 +03:00
shows how to install the Ubuntu 20 package:
2020-05-30 20:30:32 +03:00
2023-03-16 05:22:51 +03:00
```console
$ curl -LO {{ ubuntu20_deb_stable }}
$ sudo apt install -y ./{{ ubuntu20_deb_stable_asset }}
2020-05-30 20:30:32 +03:00
```
* The package installs `/usr/bin/wezterm` and `/usr/share/applications/org.wezfurlong.wezterm.desktop`
2023-03-16 05:22:51 +03:00
* Configuration instructions can be [found here ](../config/files.md )
2020-05-30 20:30:32 +03:00
2023-10-03 20:40:57 +03:00
## Installing on Fedora and rpm-based Systems via Copr
Nightly builds of wezterm are now available via the [Copr ](https://copr.fedorainfracloud.org/ ) build service.
You can see the current list of available distributions and architectures
[on the wezterm-nightly project page ](https://copr.fedorainfracloud.org/coprs/wezfurlong/wezterm-nightly/ ).
At the time that this page was written, the following distributions are available in Copr for `x86_64` and `aarch64` :
* Centos Stream 8 and 9
* Fedora 38, 39, rawhide
* OpenSUSE Leap 15.5
* OpenSUSE Tumbleweed
* RHEL 8, 9
To perform initial installation:
```console
$ sudo dnf copr enable wezfurlong/wezterm-nightly
$ sudo dnf install wezterm
```
To update:
```console
$ sudo dnf update wezterm
```
2020-05-30 20:30:32 +03:00
## Installing on Fedora and rpm-based Systems
2022-04-26 09:58:34 +03:00
The CI system builds `.rpm` files on CentOS, Fedora and openSUSE systems.
2020-05-30 20:30:32 +03:00
These are likely compatible with other rpm-based distributions.
Alternatively, you can try the AppImage download with should work
on most Linux systems.
|Distro | Stable | Nightly |
|------------|------------------|---------------------|
2024-01-18 16:12:39 +03:00
|CentOS7 |[{{ centos7_rpm_stable_asset }}]({{ centos7_rpm_stable }}) |No longer supported|
2022-02-01 23:12:22 +03:00
|CentOS8 |[{{ centos8_rpm_stable_asset }}]({{ centos8_rpm_stable }}) |[{{ centos8_rpm_nightly_asset }}]({{ centos8_rpm_nightly }})|
2022-04-20 17:57:04 +03:00
|CentOS9 |[{{ centos9_rpm_stable_asset }}]({{ centos9_rpm_stable }})|[{{ centos9_rpm_nightly_asset }}]({{ centos9_rpm_nightly }})|
2023-11-25 06:20:04 +03:00
|Fedora36 |[{{ fedora36_rpm_stable_asset }}]({{ fedora36_rpm_stable }})|No longer supported|
2023-03-21 03:58:30 +03:00
|Fedora37 |[{{ fedora37_rpm_stable_asset }}]({{ fedora37_rpm_stable }})|[{{ fedora37_rpm_nightly_asset }}]({{ fedora37_rpm_nightly }})|
2023-07-12 22:57:19 +03:00
|Fedora38 |[{{ fedora38_rpm_stable_asset }}]({{ fedora38_rpm_stable }})|[{{ fedora38_rpm_nightly_asset }}]({{ fedora38_rpm_nightly }})|
2023-11-25 06:20:04 +03:00
|Fedora39 |Nightly only|[{{ fedora39_rpm_nightly_asset }}]({{ fedora39_rpm_nightly }})|
2023-11-04 19:41:53 +03:00
|openSUSE Leap |[{{ opensuse_leap_rpm_stable_asset }}]({{ opensuse_leap_rpm_stable }})|Use COPR instead|
|openSUSE Tumbleweed |[{{ opensuse_tumbleweed_rpm_stable_asset }}]({{ opensuse_tumbleweed_rpm_stable }})|Use COPR instead|
2020-05-30 20:30:32 +03:00
2021-05-02 19:32:38 +03:00
To download and install from the CLI you can use something like this, which
2023-04-20 07:51:17 +03:00
shows how to install the Fedora 37 package:
2020-05-30 20:30:32 +03:00
2023-03-16 05:22:51 +03:00
```console
2023-04-20 07:51:17 +03:00
$ sudo dnf install -y {{ fedora37_rpm_stable }}
2020-05-30 20:30:32 +03:00
```
2022-05-09 19:25:09 +03:00
WezTerm is also available in the official Factory repo in openSUSE Tumbleweed. To install from Factory instead
from the rpm provided by WezTerm's Github repository, you can use Yast. If you prefer the CLI, you can install
it as root user with
2023-03-16 05:22:51 +03:00
```console
$ zypper addrepo https://download.opensuse.org/repositories/openSUSE:Factory/standard/openSUSE:Factory.repo
$ zypper refresh
$ zypper install wezterm
2022-05-09 19:25:09 +03:00
```
2020-05-30 20:30:32 +03:00
* The package installs `/usr/bin/wezterm` and `/usr/share/applications/org.wezfurlong.wezterm.desktop`
2023-03-16 05:22:51 +03:00
* 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
## Arch Linux
2023-09-30 10:41:35 +03:00
WezTerm is available in the [Extra repository ](https://archlinux.org/packages/extra/x86_64/wezterm/ ).
2021-04-05 03:33:11 +03:00
2023-09-30 10:41:35 +03:00
The version available in the extra repository may lag behind the latest wezterm release, so you may
2021-04-05 03:33:11 +03:00
wish to use one of these AUR options:
2020-06-08 00:45:45 +03:00
2020-06-08 01:18:13 +03:00
|What |Where|
2020-06-08 00:52:40 +03:00
|---------------------|-|
2020-06-08 00:45:45 +03:00
|Build from source |< https: / / aur . archlinux . org / packages / wezterm-git / > |
2022-04-20 09:35:21 +03:00
## Alpine Linux
2023-05-28 00:10:07 +03:00
APKs are no longer being built/supported by CI. You can still build it for yourself from source!
2022-04-20 09:35:21 +03:00
2020-07-18 20:16:30 +03:00
## Linuxbrew Tap
2020-07-18 20:16:51 +03:00
If you are a [Linuxbrew ](https://docs.brew.sh/Homebrew-on-Linux ) user, you can install
2020-07-18 20:16:30 +03:00
wezterm from our tap:
2023-03-16 05:22:51 +03:00
```console
2020-07-18 20:16:30 +03:00
$ brew tap wez/wezterm-linuxbrew
$ brew install wezterm
```
If you'd like to use a nightly build you can perform a head install:
2023-03-16 05:22:51 +03:00
```console
2020-07-18 20:16:30 +03:00
$ brew install --HEAD wezterm
```
2020-10-31 08:32:59 +03:00
to upgrade to a newer nightly, it is simplest to remove then
install:
2023-03-16 05:22:51 +03:00
```console
2020-10-31 08:32:59 +03:00
$ brew rm wezterm
$ brew install --HEAD wezterm
```
2020-05-30 20:30:32 +03:00
## Raw Linux Binary
Another option for linux is a raw binary archive. These are the same binaries that
are built for Ubuntu but provided in a tarball.
2023-03-16 05:22:51 +03:00
[Raw Linux Binary :material-tray-arrow-down: ]({{ linux_raw_bin_stable }} ){ .md-button }
[Nightly Raw Linux Binary :material-tray-arrow-down: ]({{ linux_raw_bin_nightly }} ){ .md-button }
2020-05-30 20:30:32 +03:00