mirror of
https://github.com/wez/wezterm.git
synced 2024-12-25 22:33:52 +03:00
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
## Configuration Files
|
|
|
|
`wezterm` will look for a [lua](https://www.lua.org/manual/5.3/manual.html)
|
|
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 contains `wezterm.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.
|
|
|
|
**The configuration file may be evaluated multiple times for each wezterm
|
|
process** both at startup and in response to the configuration file being
|
|
reloaded. You should avoid taking actions in the main flow of the config file
|
|
that have side effects; for example, unconditionally launching background
|
|
processes can result in many of them being spawned over time if you launch
|
|
many copies of wezterm, or are frequently reloading your config file.
|
|
|
|
## 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:
|
|
|
|
```lua
|
|
return {
|
|
}
|
|
```
|
|
|
|
Throughout these docs you'll find configuration fragments that demonstrate
|
|
configuration and that look something like this:
|
|
|
|
```lua
|
|
return {
|
|
color_scheme = "Batman",
|
|
}
|
|
```
|
|
|
|
and perhaps another one like this:
|
|
|
|
```lua
|
|
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:
|
|
|
|
```lua
|
|
local wezterm = require 'wezterm';
|
|
return {
|
|
font = wezterm.font("JetBrains Mono"),
|
|
color_scheme = "Batman",
|
|
}
|
|
```
|
|
|
|
|
|
|