1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-24 13:52:55 +03:00
A GPU-accelerated cross-platform terminal emulator and multiplexer written by @wez and implemented in Rust
Go to file
Mark Thomas 6164860a10 add alternate screen support
Add new methods to the `Terminal` trait for entering and exiting the alternate
screen.
2019-05-18 09:12:46 -07:00
.cargo Now with something approximating windows support 2018-07-20 20:39:16 -07:00
assets Embed icon into windows executable and titlebar 2019-03-24 19:08:07 -07:00
base91 Add base91 crate 2019-03-07 09:03:19 +00:00
ci Ask travis to build and publish a .deb to a github release 2019-03-24 17:49:28 -07:00
deps bindgen: skip layout tests 2019-03-24 11:08:14 -07:00
promise tweak executor trait for compat with x11 2019-03-04 23:13:37 +00:00
screenshots add screenshot 2018-02-19 22:10:59 -08:00
src use AtomicUsize::new(0) instead of ATOMIC_USIZE_INIT 2019-05-05 06:57:32 -07:00
term avoid deadlock while pasting large chunks of text 2019-03-23 15:25:49 -07:00
termwiz add alternate screen support 2019-05-18 09:12:46 -07:00
varbincode Employ zstd compression for large pdus 2019-03-22 20:41:50 -07:00
.gitignore Revert "add snapcraft build config" 2019-05-04 08:25:30 -07:00
.gitmodules remove esctest 2019-03-23 14:30:54 -07:00
.rustfmt.toml update rustfmt for 1.28 2018-08-03 22:34:27 -07:00
.travis.yml travis: install fakeroot for deb packaging 2019-03-24 18:23:04 -07:00
appveyor.yml appveyor: revise deploy filter 2019-03-24 16:03:48 -07:00
build.rs Embed icon into windows executable and titlebar 2019-03-24 19:08:07 -07:00
Cargo.toml update glium dep; can drop our patch for it now 2019-05-05 06:55:19 -07:00
CONTRIBUTING.md Add get-deps script for installing dependencies 2018-02-25 09:24:56 -08:00
get-deps adjust get-deps for recent deps changes 2019-03-23 15:30:18 -07:00
install.sh refine deploy scripts/config 2019-03-24 00:26:53 -07:00
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md 2018-02-25 08:22:55 -08:00
LICENSE.md restructure termwiz tree prior to merging into wezterm repo 2018-08-05 07:55:30 -07:00
README.md fix typo in the readme 2019-03-24 17:04:07 -07:00
wt-record update record/play scripts for macos 2019-03-22 20:41:50 -07:00
wt-replay update record/play scripts for macos 2019-03-22 20:41:50 -07:00

Wez's Terminal

A terminal emulator implemented in Rust, using OpenGL for rendering.

Build Status Build status

Screenshot

Screenshot of wezterm on X11, running vim

Installing a package

Installing from source

  • Install rustup to get the rust compiler installed on your system. https://www.rust-lang.org/en-US/install.html
  • Build in release mode: cargo build --release
  • Run it via either cargo run --release or target/release/wezterm

You will need a collection of support libraries; the get-deps script will attempt to install them for you. If it doesn't know about your system, please contribute instructions!

$ curl https://sh.rustup.rs -sSf | sh -s
$ git clone --depth=1 --branch=master --recursive https://github.com/wez/wezterm.git
$ cd wezterm
$ git submodule update --init
$ sudo ./get-deps
$ cargo build --release
$ cargo run --release -- start

What?

Here's what I'm shooting for:

  • A terminal escape sequence parser
  • A model of a terminal screen + scrollback that is OS independent
  • Textual and GUI rendering of the model
  • A differential protocol for the model

This would manifest as a common core that could run as both a textual terminal multiplexer and a gui terminal emulator, where the GUI part could automatically provide a native UI around the remotely multiplexed terminal session.

Status / Features - Beta Quality

There may be bugs that cause the terminal to panic. I'd recommend using tmux or screen to keep your session alive if you are working on something important!

Despite the warning above, I've been using wezterm as my daily driver since the middle of Feb 2018. The following features are done:

  • Runs on
  • Linux under X (requires OpenGL ES 3)
  • macOS
  • Windows 10 with ConPty
  • True Color support
  • Ligatures, Color Emoji and font fallback
  • Hyperlinks per: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
  • Scrollback (use mouse wheel and Shift Page{Up|Down})
  • xterm style selection of text with mouse; paste selection via Shift-Insert (bracketed paste is supported!)
  • SGR style mouse reporting (works in vim and tmux)
  • Render underline, double-underline, italic, bold, strikethrough
  • Configuration file to specify fonts and colors
  • Multiple Windows (Hotkey: Super-N)
  • Tabs (Hotkey: Super-T, next/prev: Super-[ and Super-], go-to: Super-[0-9])

There's a good number of terminal escape sequences that are not yet implemented and that will get fleshed out as the applications I use uncover them, or as folks report them here and raise the priority. Similarly for key mappings. Please don't be shy about contributing support for missing things!

Things that I'd like to see happen and that have no immediate priority; contributions to get closer to these are welcomed!

Configuration

wezterm will look for a TOML configuration file in $HOME/.config/wezterm/wezterm.toml, and then in $HOME/.wezterm.toml.

Configuration is currently very simple and the format is considered unstable and subject to change. The code for configuration can be found in src/config.rs.

I use the following in my ~/.wezterm.toml:

font_size = 10
font = { font = [{family = "Operator Mono SSm Lig Medium"}] }
# How many lines of scrollback to retain
scrollback_lines = 3500

[[font_rules]]
italic = true
font = { font = [{family = "Operator Mono SSm Lig Medium", italic=true}]}

[[font_rules]]
italic = true
intensity = "Bold"
font = { font = [{family = "Operator Mono SSm Lig", italic=true, bold=true}]}

[[font_rules]]
intensity = "Bold"
  [font_rules.font]
  font = [{family = "Operator Mono SSm", bold=true}]
  # if you liked xterm's `boldColor` setting, this is how you do it in wezterm,
  # but you can apply it to any set of matching attributes!
  foreground = "tomato"

[[font_rules]]
intensity = "Half"
font = { font=[{family = "Operator Mono SSm Lig Light" }]}

The default configuration will attempt to use whichever font is returned from fontconfig when monospace is requested.

Colors

You can configure colors with a section like this. In addition to specifying SVG/CSS3 color names, you can use #RRGGBB to specify a color code using the usual hex notation; eg: #000000 is equivalent to black:

[colors]
foreground = "silver"
background = "black"
cursor_bg = "springgreen"
ansi = ["black", "maroon", "green", "olive", "navy", "purple", "teal", "silver"]
brights = ["grey", "red", "lime", "yellow", "blue", "fuchsia", "aqua", "white"]

Performance

While ultimate speed is not the main goal, performance is important! Using the GPU to render the terminal contents helps keep CPU usage down and the output feeling snappy.

If you want the absolute fastest terminal emulator, alacritty is currently king of the crop.

Getting help

This is a spare time project, so please bear with me. There are two channels for support:

The gitter room is probably better suited to questions than it is to bug reports, but don't be afraid to use whichever you are most comfortable using and we'll work it out.