15e0deae2b
Initial support for Windows is implemented using the winpty translation layer. Clipboard support for Windows is provided through the `clipboard` crate, and font rasterization is provided by RustType. The tty.rs file has been split into OS-specific files to separate standard pty handling from the winpty implementation. Several binary components are fetched via build script on windows including libclang and winpty. These could be integrated more directly in the future either by building those dependencies as part of the Alacritty build process or by leveraging git lfs to store the artifacts. Fixes #28. |
||
|---|---|---|
| .github | ||
| assets | ||
| copypasta | ||
| docs | ||
| font | ||
| res | ||
| scripts | ||
| servo-freetype-proxy | ||
| snap | ||
| src | ||
| tests | ||
| winpty | ||
| .agignore | ||
| .gitignore | ||
| .travis.yml | ||
| alacritty-completions.bash | ||
| alacritty-completions.fish | ||
| alacritty-completions.zsh | ||
| alacritty.desktop | ||
| alacritty.info | ||
| alacritty.man | ||
| alacritty.yml | ||
| alacritty_macos.yml | ||
| alacritty_windows.yml | ||
| appveyor.yml | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| INSTALL.md | ||
| LICENSE-APACHE | ||
| Makefile | ||
| README.md | ||
Alacritty
Alacritty is the fastest terminal emulator in existence. Using the GPU for rendering enables optimizations that simply aren't possible in other emulators. Alacritty currently supports macOS and Linux, and Windows.
About
Alacritty is focused on simplicity and performance. The performance goal means it should be faster than any other terminal emulator available. The simplicity goal means that it doesn't have features such as tabs or splits (which can be better provided by a window manager or terminal multiplexer) nor niceties like a GUI config editor.
The software is considered to be at an alpha level of readiness--there are missing features and bugs to be fixed, but it is already used by many as a daily driver.
Precompiled binaries are available for Windows through appveyor. Precompiled binaries for other platforms are minimally blocked on a stable config format. For now, Alacritty must be built from source.
Further information
- Announcing Alacritty, a GPU-Accelerated Terminal Emulator January 6, 2017
- A short talk about Alacritty at the Rust Meetup January 2017 (starts at 57:00)
- Alacritty Lands Scrollback, Publishes Benchmarks September 17, 2018
Installation
Some operating systems already provide binaries for Alacritty, for everyone else the instructions to build Alacritty from source, can be found here.
Arch Linux
pacman -S alacritty
Debian/Ubuntu
Using cargo deb, you can create and install a deb file.
git clone https://github.com/jwilm/alacritty.git
cd alacritty
cargo install cargo-deb
cargo deb --install
openSUSE Tumbleweed Linux
zypper in alacritty
Void Linux
xbps-install alacritty
Windows
Prebuilt binaries can be downloaded from the artifacts section of appveyor.
Configuration
Although it's possible the default configuration would work on your system,
you'll probably end up wanting to customize it anyhow. There is a default
alacritty.yml, alacritty_macos.yml, and alacritty_windows.yml at the git repository root.
Alacritty looks for the configuration file as the following paths:
$XDG_CONFIG_HOME/alacritty/alacritty.yml$XDG_CONFIG_HOME/alacritty.yml$HOME/.config/alacritty/alacritty.yml$HOME/.alacritty.yml
If none of these paths are found then
$XDG_CONFIG_HOME/alacritty/alacritty.yml is created once alacritty is first
run. On most systems this often defaults to
$HOME/.config/alacritty/alacritty.yml.
Many configuration options will take effect immediately upon saving changes to
the config file. The only exception is the font and dimensions sections
which requires Alacritty to be restarted. For further explanation of the config
file, please consult the comments in the default config file.
Windows
On windows the config file is located at:
%UserProfile%\alacritty.yml
Issues (known, unknown, feature requests, etc)
If you run into a problem with Alacritty, please file an issue. If you've got a
feature request, feel free to ask about it. Keep in mind that Alacritty is very
much not looking to be a feature-rich terminal emulator with all sorts of bells
and widgets. It's primarily a cross-platform, blazing fast tmux renderer that
Just Works.
FAQ
Is it really the fastest terminal emulator?
In the terminals I've benchmarked against, alacritty is either faster, WAY faster, or at least neutral. There are no benchmarks in which I've found Alacritty to be slower.
macOS + tmux + vim is slow! I thought this was supposed to be fast!
This appears to be an issue outside of terminal emulators; either macOS has an
IPC performance issue, or either tmux or vim (or both) have a bug. This same
issue can be seen in iTerm2 and Terminal.app. I've found that if tmux is
running on another machine which is connected to Alacritty via SSH, this issue
disappears. Actual throughput and rendering performance are still better in
Alacritty.
My arrow keys don't work.
It sounds like you deleted some key bindings from your config file. Please reference the default config file to restore them.
IRC
Alacritty discussion can be found in #alacritty on freenode.
Wayland
Wayland support is available, but not everything works as expected. Many people
have found a better experience using XWayland which can be achieved launching
Alacritty with the WAYLAND_DISPLAY environment variable cleared:
env WAYLAND_DISPLAY= alacritty
If you're interested in seeing our Wayland support improve, please head over to the Wayland meta issue on the winit project to see how you may contribute.
License
Alacritty is released under the Apache License, Version 2.0.