1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-03 04:34:21 -05:00
A cross-platform, OpenGL terminal emulator.
Find a file
Christian Duerr 0b1754e73f
Fix clippy issues
This resolves all existing clippy issues and removes some old `allow`
annotations which aren't neccesary anymore.
2018-11-04 00:11:51 +00:00
.github Add issue template 2017-08-29 08:32:14 -07:00
assets Add support for Windows (#1374) 2018-10-16 10:02:52 -07:00
ci Fix windows tagged builds 2018-11-03 18:46:26 +00:00
copypasta Add support for Windows (#1374) 2018-10-16 10:02:52 -07:00
docs starting not staring (#1074) 2018-02-11 09:50:52 -08:00
font Fix clippy issues 2018-11-04 00:11:51 +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 clippy issues 2018-11-04 00:11:51 +00:00
tests Fix failing test with bench feature 2018-09-29 20:48:24 +00:00
winpty Fix deb build 2018-10-31 19:47:21 +00:00
.agignore Add silver searcher ignore file 2016-12-29 10:49:12 -05:00
.gitignore Add support for Windows (#1374) 2018-10-16 10:02:52 -07:00
.travis.yml Publish Github releases from Travis 2018-11-03 15:08:30 +00:00
alacritty-completions.bash Add cargo deb build instructions 2018-07-15 13:00:58 +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 Add statusline capabilities to Terminfo 2018-10-14 22:23:54 +00:00
alacritty.man Version 0.2.1 2018-10-03 08:13:14 -07:00
alacritty.yml Rework cursor configuration 2018-11-01 17:23:49 +00:00
alacritty_macos.yml Rework cursor configuration 2018-11-01 17:23:49 +00:00
alacritty_windows.yml Rework cursor configuration 2018-11-01 17:23:49 +00:00
appveyor.yml Add cargo workspace, add winpty tests to CI 2018-10-29 20:52:14 +13:00
build.rs build(package): acquire latest winpty 2018-10-17 18:38:33 +13:00
Cargo.lock Update serde_yaml to 0.8 2018-11-01 11:45:20 +00:00
Cargo.toml Publish Github releases from Travis 2018-11-03 15:08:30 +00:00
CHANGELOG.md Publish Github releases from Travis 2018-11-03 15:08:30 +00:00
INSTALL.md Move gentoo install instructions, add windows to table of contents 2018-10-27 15:58:51 +13:00
LICENSE-APACHE Add license headers to source files 2016-06-29 20:59:14 -07:00
Makefile Sync .app bundle timestamp during build 2018-10-31 19:48:04 +00:00
README.md Add Instructions for installing on FreeBSD 2018-11-01 20:09:19 +00:00

Alacritty

Travis build Status Appveyor 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 macOS and Linux, and Windows.

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

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

Gentoo Linux

emerge x11-terms/alacritty

FreeBSD

pkg 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:

  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.

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.