1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-11 13:51:01 -05:00
A cross-platform, OpenGL terminal emulator.
Find a file
Christian Duerr f0cb1e7cf3
Bump alacritty_terminal version
This change bumps the version of the `alacritty_terminal` crate to force
it out of sync with the Alacritty application. Since it is a library
that will be published on crates.io, it should be following semver
rather than our binary's release version.

While it would be possible to just keep it at 0.5.0, explicitly
disconnecting it from the Alacritty version should give it a clean
starting-off point and prevent unnecessary confusion. Bumping it to
0.10.0 instead of something like 0.6.0 should allow for a nice gap
between the different versions without being too arbitrary. Changing the
version to 0.1.0 is not an option since decreasing semver version would
likely cause a lot of problems.

While it would be possible to further separate the Alacritty terminal
library from the Alacritty terminal emulator, by renaming it from
`alacritty_terminal` to something different, I don't think that is
necessary or a good idea at the moment. Even though the
`alacritty_terminal` library *can* be used for other terminals, its
primary goal is still to support the Alacritty terminal emulator and I
don't see that changing. So making that clear in its name seems like a
good idea. Since there is no plan to maintain this library separately
from Alacritty, but to keep both tied together, the naming should
reflect this.
2020-07-19 14:14:31 +00:00
.builds Fix rustfmt build failures 2020-07-18 18:02:06 +00:00
.copr Add RPM spec for building in COPR 2019-06-09 16:30:42 +00:00
.github Bump alacritty_terminal version 2020-07-19 14:14:31 +00:00
alacritty Bump alacritty_terminal version 2020-07-19 14:14:31 +00:00
alacritty_terminal Bump alacritty_terminal version 2020-07-19 14:14:31 +00:00
ci Run rustfmt on sr.ht 2020-06-23 11:13:14 +00:00
docs Document supported escape sequences 2020-07-03 20:27:18 +00:00
extra Update --help for class option to match manpage 2020-07-04 09:13:32 +03:00
res Fix emojis being blended with background 2020-05-12 16:23:35 +03:00
scripts Switch to flamegraph-rs script 2020-01-27 02:30:23 +03:00
.agignore
.gitattributes Add custom merge strategy for CHANGELOG.md 2020-02-15 13:25:02 +03:00
.gitignore Switch to flamegraph-rs script 2020-01-27 02:30:23 +03:00
.travis.yml Remove checks on nightly from CI 2020-06-23 11:13:14 +00:00
alacritty.yml Add support for searching without vi mode 2020-07-15 21:27:32 +00:00
Cargo.lock Bump alacritty_terminal version 2020-07-19 14:14:31 +00:00
Cargo.toml Rename font crate to crossfont 2020-07-18 01:27:41 +00:00
CHANGELOG.md Fallback to SHELL instead of passwd if present 2020-07-14 09:03:36 +00:00
CONTRIBUTING.md Bump alacritty_terminal version 2020-07-19 14:14:31 +00:00
INSTALL.md Remove prebuilt linux binaries 2020-05-12 15:18:37 +00:00
LICENSE-APACHE Remove copyright notice from files 2020-06-06 21:49:14 +03:00
Makefile Add auxiliary files to macOS Application bundle 2020-07-04 14:03:48 +00:00
README.md Remove Ubuntu PPA installation instructions 2020-07-16 01:33:40 +00:00
rustfmt.toml Fix clippy issues 2019-08-16 01:33:49 +02:00

Alacritty

Alacritty Logo

Alacritty is the fastest terminal emulator in existence. Using the GPU for rendering enables optimizations that simply aren't possible without it. Alacritty currently supports macOS, Linux, BSD, and Windows.

Alacritty running vim inside tmux

About

Alacritty is a terminal emulator with a strong focus on simplicity and performance. With such a strong focus on performance, included features are carefully considered and you can always expect Alacritty to be blazingly fast. By making sane choices for defaults, Alacritty requires no additional setup. However, it does allow configuration of many aspects of the terminal.

The software is considered to be at a beta level of readiness -- there are a few 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.

Alpine Linux

apk add alacritty

Arch Linux

pacman -S alacritty

Fedora

Unofficial builds of stable tags can be found in Fedora Copr: pschyska/alacritty.

dnf copr enable pschyska/alacritty
dnf install alacritty

If you want to help test pre-releases, you can additionally enable pschyska/alacritty-testing.

Gentoo Linux

emerge x11-terms/alacritty

GNU Guix

guix package -i alacritty

Mageia

urpmi alacritty

NixOS

nix-env -iA nixos.alacritty

openSUSE Tumbleweed

zypper in alacritty

Pop!_OS

apt install alacritty

Solus

eopkg install alacritty

Void Linux

xbps-install alacritty

FreeBSD

pkg 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. These are located inside the installed application's Resources directory: Alacritty.app/Contents/Resources.

Windows

Via Chocolatey

choco install alacritty

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. If your desktop environment has trouble rendering the default SVG icons, you can find a prerendered SVG as well as simplified versions of the SVG in the extra/logo/compat directory.

On Windows, Alacritty also requires Microsoft's VC++ redistributable.

For Windows versions older than Windows 10 (October 2018 Update), 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

You can find the default configuration file with documentation for all available fields on the GitHub releases page for each release.

Alacritty doesn't create the config file for you, but it looks for one in the following locations:

  1. $XDG_CONFIG_HOME/alacritty/alacritty.yml
  2. $XDG_CONFIG_HOME/alacritty.yml
  3. $HOME/.config/alacritty/alacritty.yml
  4. $HOME/.alacritty.yml

Windows

On Windows, the config file should be located at:

%APPDATA%\alacritty\alacritty.yml

Contributing

A full guideline about contributing to Alacritty can be found in the CONTRIBUTING.md 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. Please just keep in mind Alacritty is focused on simplicity and performance, and not all features are in line with that goal.

Before opening a new issue, please check if it has already been reported. There's a chance someone else has already reported it, and you can subscribe to that issue to keep up on the latest developments.

FAQ

Is it really the fastest terminal emulator?

In the terminals we've benchmarked, Alacritty is either faster or way faster than the others. If you've found a case where this isn't true, please report a bug.

Why isn't feature X implemented?

Alacritty has many great features, but not every feature from every other terminal. This could be for a number of reasons, but sometimes it's just not a good fit for Alacritty. This means you won't find things like tabs or splits (which are best left to a window manager or terminal multiplexer) nor niceties like a GUI config editor.

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.

IRC

Alacritty discussion can be found in #alacritty on freenode.

Wayland

Wayland is used by default on systems that support it. Using XWayland may circumvent Wayland specific issues and can be enabled through:

env WINIT_UNIX_BACKEND=x11 alacritty

License

Alacritty is released under the Apache License, Version 2.0.