Skip to main content

Welcome to WezTerm

WezTerm is a GPU-accelerated cross-platform terminal emulator and multiplexer written by @wez and implemented in Rust. It combines the speed and reliability of modern systems programming with a rich feature set designed for developers, system administrators, and power users.

Installation

Get WezTerm installed on Linux, macOS, Windows, or FreeBSD

Quick Start

Launch WezTerm and create your first configuration in under 5 minutes

Configuration Reference

Explore the full Lua configuration API and customization options

Multiplexing

Learn about tabs, panes, and remote session management

Why WezTerm?

WezTerm stands out from other terminal emulators with its powerful combination of features:

GPU Accelerated

Hardware-accelerated rendering for smooth scrolling and performance

Cross-Platform

Runs on Linux, macOS, Windows 10+, FreeBSD, and NetBSD

Multiplexing Built-In

Native support for tabs, panes, and remote sessions without tmux

Rich Typography

Ligatures, color emoji, and font fallback with true color support

Lua Configuration

Flexible configuration using Lua with hot reloading

SSH Integration

Built-in SSH client with session persistence

Key Features

Terminal Emulation

  • Full xterm-style terminal emulation with modern extensions
  • True color (24-bit RGB) support
  • Advanced text rendering: ligatures, color emoji, fallback fonts
  • Multiple text styles: underline, double-underline, italic, bold, strikethrough
  • Searchable scrollback with regex support

Window Management

  • Multiple Windows: Launch independent terminal windows (Super+N)
  • Tabs: Organize terminals in tabs (Super+T to create, Super+1-9 to switch)
  • Splits/Panes: Split terminals horizontally or vertically (Ctrl+Shift+Alt+% and Ctrl+Shift+Alt+")
  • Native mouse support: Click, drag, scroll with full mouse integration

Remote Connectivity

  • Built-in SSH client: Connect directly to remote hosts
  • Session multiplexing: Attach and detach from remote sessions
  • Unix domain sockets: Local multiplexer for persistent sessions
  • TLS connections: Secure remote multiplexing over TCP/IP

Developer-Friendly

  • Hot reload: Configuration changes apply immediately (Ctrl+Shift+R)
  • Lua API: Powerful scripting for custom behaviors and workflows
  • 700+ color schemes: Pre-installed themes from iTerm2, base16, Gogh, and more
  • Font inspection: Use wezterm ls-fonts to debug font configuration

Image Support

  • iTerm2 image protocol with built-in imgcat command
  • Kitty graphics protocol
  • Sixel graphics support

Platform Support

WezTerm runs on all major platforms:
  • Package formats: DEB, RPM, Flatpak, AppImage, Arch AUR
  • Package managers: APT, DNF, Copr, Homebrew, Nix, Pacman
  • Distributions: Ubuntu, Debian, Fedora, CentOS, Arch, openSUSE, NixOS
  • Architectures: x86_64, ARM64

Getting Started

1

Install WezTerm

Follow the installation guide for your operating system. Most platforms offer multiple installation methods including package managers.
2

Launch the Terminal

Open WezTerm from your applications menu, or run wezterm from the command line.
3

Create Your Config

Follow the quick start guide to create a .wezterm.lua configuration file and customize your terminal.
4

Explore Features

Try creating tabs with Super+T, split panes with Ctrl+Shift+Alt+%, and explore the command palette with Ctrl+Shift+P.

Community and Support

GitHub Issues

Report bugs and request features

GitHub Discussions

Ask questions and chat with other users

Matrix Chat

Real-time community chat on Matrix/Element

Sponsor the Project

Support WezTerm development
WezTerm is free and open source software. If you use and enjoy WezTerm, consider sponsoring the project to help cover maintenance costs and validate the time spent on development.

What’s Next?

Ready to get started? Head to the installation guide to install WezTerm on your system, or jump straight to the quick start guide if you already have it installed.

Build docs developers (and LLMs) love