Bump version to 0.4.0

10 files changed
tree: 867247ad701e13748b6e0bf988012121940a1903
  1. .copr/
  2. .github/
  3. alacritty/
  4. alacritty_terminal/
  5. ci/
  6. copypasta/
  7. docs/
  8. extra/
  9. font/
  10. res/
  11. scripts/
  12. servo-freetype-proxy/
  13. winpty/
  14. .agignore
  15. .gitignore
  16. .travis.yml
  17. alacritty.yml
  18. Cargo.lock
  19. Cargo.toml
  20. CHANGELOG.md
  21. CONTRIBUTING.md
  22. INSTALL.md
  23. LICENSE-APACHE
  24. Makefile
  25. README.md
  26. rustfmt.toml
README.md

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.

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.

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

Mageia

urpmi alacritty

NixOS

nix-env -iA nixos.alacritty

openSUSE Tumbleweed

zypper in alacritty

Pop!_OS / Ubuntu

If you‘re not running Pop!_OS, you’ll have to add a third party repository first:

add-apt-repository ppa:mmstick76/alacritty
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.

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.

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.

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

Configuration

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

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

Windows

On Windows the config file is 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.

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