refs: 459
1.9 KiB
Configuration Files
wezterm
will look for a lua
configuration file in the following locations, stopping at the first file that
it finds:
- (in the nightly builds) if the
--config-file
CLI argument was specified, then that path will be used. If that path fails to load, then the defaults will be used instead. - If the environment variable
$WEZTERM_CONFIG_FILE
is set, it will be treated as the path to a configuration file. In the nightly builds: if that path fails to load then the defaults will be used instead. In earlier releases, the following steps would be used as a fallback. - On Windows,
wezterm.lua
from the directory that containswezterm.exe
. This is handy for users that want to carry their wezterm install around on a thumb drive. $HOME/.config/wezterm/wezterm.lua
,$HOME/.wezterm.lua
wezterm
will watch the config file that it loads; if/when it changes, the
configuration will be automatically reloaded and the majority of options will
take effect immediately. You may also use the CTRL+SHIFT+R
keyboard shortcut
to force the configuration to be reloaded.
Configuration File Structure
The wezterm.lua
configuration file is a lua script which allows for a high
degree of flexibility. The script is expected to return a configuration
table, so a basic empty configuration file will look like this:
return {
}
Throughout these docs you'll find configuration fragments that demonstrate configuration and that look something like this:
return {
color_scheme = "Batman",
}
and perhaps another one like this:
local wezterm = require 'wezterm';
return {
font = wezterm.font("JetBrains Mono"),
}
If you wanted to use both of these in the same file, you would merge them together like this:
local wezterm = require 'wezterm';
return {
font = wezterm.font("JetBrains Mono"),
color_scheme = "Batman",
}