1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-18 13:55:23 -05:00
A cross-platform, OpenGL terminal emulator.
Find a file
Christian Duerr 0c8e583d1d
Improve constant naming
Since `DEFAULT_TITLE` applies to both window class and title, it has
been changed to `DEFAULT_NAME` to better represent what it's used for.
2019-02-06 21:07:44 +01:00
.github Add issue template 2017-08-29 08:32:14 -07:00
assets Bump version to 0.2.7 2019-01-21 16:39:24 +00:00
ci Document that alacritty requires winpty-agent on windows 2019-02-02 12:00:29 +00:00
copypasta Normalize Log Message Strings 2019-01-07 00:06:57 +00:00
debian Changed path to standard /usr/bin/..., registered as an x-terminal-emulator alternative 2018-11-19 09:24:22 +00:00
docs starting not staring (#1074) 2018-02-11 09:50:52 -08:00
font Remove library lockfiles from git 2019-02-04 23:12:56 +00:00
res Simplify text shader 2019-02-04 19:03:25 +00:00
scripts Changed explicit script shebangs to use /usr/bin/env 2019-01-21 22:12:09 +00:00
servo-freetype-proxy Bump fontconfig dependencies 2018-09-30 20:44:14 +00:00
snap Bump version to 0.2.7 2019-01-21 16:39:24 +00:00
src Improve constant naming 2019-02-06 21:07:44 +01:00
tests Fixing tabs in copy-paste 2018-12-15 21:33:33 +00:00
winpty Remove library lockfiles from git 2019-02-04 23:12:56 +00:00
.agignore Add silver searcher ignore file 2016-12-29 10:49:12 -05:00
.gitignore Remove library lockfiles from git 2019-02-04 23:12:56 +00:00
.travis.yml Move clippy tests to stable 2019-01-23 22:04:45 +00:00
alacritty-completions.bash Display errors and warnings 2018-11-17 14:39:13 +00:00
alacritty-completions.fish Display errors and warnings 2018-11-17 14:39:13 +00:00
alacritty-completions.zsh Display errors and warnings 2018-11-17 14:39:13 +00:00
alacritty.desktop Update to glutin 0.16.0 2018-05-29 09:50:49 -07:00
alacritty.info Fix color issues in ncurses programs 2018-12-12 14:12:59 +00:00
alacritty.man Bump version to 0.2.7 2019-01-21 16:39:24 +00:00
alacritty.yml Fix macOS config decorations doc 2019-02-04 00:17:57 +00:00
build.rs Upgrade to Rust 2018 2018-12-10 17:53:56 +00:00
Cargo.lock Remove library lockfiles from git 2019-02-04 23:12:56 +00:00
Cargo.toml Simplify text shader 2019-02-04 19:03:25 +00:00
CHANGELOG.md Add change log entry 2019-02-06 00:42:36 +01:00
CONTRIBUTING.md Make all configuration fields optional 2019-01-17 09:17:26 +00:00
INSTALL.md Document that alacritty requires winpty-agent on windows 2019-02-02 12:00:29 +00:00
LICENSE-APACHE Add license headers to source files 2016-06-29 20:59:14 -07:00
Makefile Set minimum macOS version to 10.11 2019-01-06 19:12:30 +00:00
README.md Document that alacritty requires winpty-agent on windows 2019-02-02 12:00:29 +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, 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 from the GitHub releases page.

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

openSUSE Tumbleweed

zypper in alacritty

Void Linux

xbps-install alacritty

Gentoo Linux

emerge x11-terms/alacritty

Mageia 7+

urpmi alacritty

FreeBSD

pkg install alacritty

NixOS

nix-env -iA nixos.alacritty

Solus

eopkg install alacritty

macOS

brew cask install alacritty

Once the cask is installed, it is recommended to setup the manual page, shell completions, and terminfo definitions.

Windows

Via Scoop

scoop bucket add extras
scoop install alacritty

Other

Prebuilt binaries for Linux, macOS, and Windows can be downloaded from the GitHub releases page.

To work properly on Windows, Alacritty requires winpty to emulate UNIX's PTY API. The agent is a single binary (winpty-agent.exe) which must be in the same directory as the Alacritty executable and is available through the GitHub releases page.

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 at the Git repository root. 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.

Windows

On Windows the config file is located at:

%APPDATA%\alacritty\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.