A cross-platform, OpenGL terminal emulator.
Go to file
Christian Duerr cb6e0653fa
Extract manual installation instructions
Alacritty's manual installation instructions take up a lot of space in
the README and they are hard to navigate because there's a lot of
information for specific distros which are irrelevant to most users.

To improve this situation, the manual installation section has been
moved to the `INSTALL.md` file. This allows keeping the readme to a
minimum which just includes the straight-forward instructions required
to install it on systems which provide packages for it.

Having a separate file also makes it possible to add a full index just
for the installation instructions, which makes it possible to skip
sections which are irrelevant.
2018-10-14 21:01:09 +00:00
.github Add issue template 2017-08-29 08:32:14 -07:00
assets/osx/Alacritty.app/Contents Version 0.2.1 2018-10-03 08:13:14 -07:00
copypasta Scrollback cleanup 2018-07-21 17:17:41 +00:00
docs `starting` not `staring` (#1074) 2018-02-11 09:50:52 -08:00
font Bump fontconfig dependencies 2018-09-30 20:44:14 +00:00
res Fix solid background color opacity (#847) 2017-10-21 15:26:42 -07:00
scripts Add hidden escape sequence 2018-09-19 19:18:51 +00:00
servo-freetype-proxy Bump fontconfig dependencies 2018-09-30 20:44:14 +00:00
snap Version 0.2.1 2018-10-03 08:13:14 -07:00
src fix erroneous indexed_color results 2018-10-07 21:10:58 +00:00
tests Fix failing test with `bench` feature 2018-09-29 20:48:24 +00:00
.agignore Add silver searcher ignore file 2016-12-29 10:49:12 -05:00
.gitignore Adding snapcraft.yaml 2017-06-20 07:56:30 -07:00
.travis.yml Merge master into scrollback 2018-07-28 23:10:13 +00:00
CHANGELOG.md fix erroneous indexed_color results 2018-10-07 21:10:58 +00:00
Cargo.lock Version 0.2.1 2018-10-03 08:13:14 -07:00
Cargo.toml Version 0.2.1 2018-10-03 08:13:14 -07:00
INSTALL.md Extract manual installation instructions 2018-10-14 21:01:09 +00:00
LICENSE-APACHE Add license headers to source files 2016-06-29 20:59:14 -07:00
Makefile Make the macOS bundle compatible osx 10.12 2018-10-03 01:38:03 +00:00
README.md Extract manual installation instructions 2018-10-14 21:01:09 +00:00
alacritty-completions.bash Merge master into scrollback 2018-07-28 23:10:13 +00:00
alacritty-completions.fish Added -d & -e to fish completions 2018-03-12 23:06:04 -07:00
alacritty-completions.zsh Add shell completions and manpage 2018-03-07 21:34:05 +00:00
alacritty.desktop Update to glutin 0.16.0 2018-05-29 09:50:49 -07:00
alacritty.info Fix reset cursor terminfo escape 2018-09-25 01:04:33 +00:00
alacritty.man Version 0.2.1 2018-10-03 08:13:14 -07:00
alacritty.yml Fix invalid default config 2018-10-07 18:40:58 +00:00
alacritty_macos.yml Fix invalid default config 2018-10-07 18:40:58 +00:00
build.rs Remove built crate 2017-12-22 14:25:14 -08:00

README.md

Alacritty

Build Status

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 FreeBSD, Linux, macOS, and OpenBSD. Windows support is planned before the 1.0 release.

Alacritty running vim inside tmux

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 will eventually be made available on supported platforms. This is minimally blocked on a stable config format. For now, Alacritty must be built from source.

Further information

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

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 and alacritty_macos.yml at the git repository root for Linux and macOS respectively.

Alacritty looks for the configuration file at the following paths:

  1. $XDG_CONFIG_HOME/alacritty/alacritty.yml
  2. $XDG_CONFIG_HOME/alacritty.yml
  3. $HOME/.config/alacritty/alacritty.yml
  4. $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.

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.

  • When will Windows support be available?

    When someone has time to work on it. Contributors would be welcomed :).

  • 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.