alacritty - Man Page
A fast, cross-platform, OpenGL terminal emulator
Examples (TL;DR)
- Open a new Alacritty window:
alacritty
- Run in a specific directory:
alacritty --working-directory path/to/directory
- Run a command in a new Alacritty window:
alacritty -e command
- Specify alternative configuration file (defaults to
$XDG_CONFIG_HOME/alacritty/alacritty.yml
):alacritty --config-file path/to/config.yml
- Run with live config reload enabled (can also be enabled by default in
alacritty.yml
):alacritty --live-config-reload --config-file path/to/config.yml
Synopsis
alacritty [Subcommands] [Flags] [Options]
Description
Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance.
Flags
- -h, --help
Prints help information
- --hold
Remain open after child process exits
- --print-events
Print all events to stdout
- -q
Reduces the level of verbosity (the min level is -qq)
- --ref-test
Generates ref test
- -v
Increases the level of verbosity (the max level is -vvv)
- -V, --version
Prints version information
Options
- --class <general> | <general>,<instance>
Defines the window class hint on Linux [default: Alacritty,Alacritty]
When only the general class is passed, instance will be set to the same value.
On Wayland the general class sets the `app_id`, while the instance class is ignored.
- -e, --command <command>...
Command and args to execute (must be last argument)
- --config-file <config-file>
Specify alternative configuration file
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.ymlOn Windows, the configuration file is located at %APPDATA%\alacritty\alacritty.yml.
- --embed <parent>
X11 window ID to embed Alacritty within (decimal or hexadecimal with "0x" prefix)
- -o, --option <option>...
Override configuration file options [example: cursor.style=Beam]
- --socket <socket>
Path for IPC socket creation
- -T, --title <title>
Defines the window title [default: Alacritty]
- --working-directory <working-directory>
Start the shell in the specified working directory
Subcommands
- msg
Available socket messages
See Also
See the alacritty github repository at https://github.com/alacritty/alacritty for the full documentation.
Bugs
Found a bug? Please report it at https://github.com/alacritty/alacritty/issues.
Maintainers
- Christian Duerr <contact@christianduerr.com>