<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/files.md - fork/wezterm @ termiz-0.23.1</title>
<meta name="description" content="docs/config/files.md in fork/wezterm at termiz-0.23.1.">
<meta property="og:title" content="docs/config/files.md - fork/wezterm @ termiz-0.23.1">
<meta property="og:description" content="docs/config/files.md in fork/wezterm at termiz-0.23.1.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termiz-0.23.1" data-tip="7053748e4d899e7fc5e202d6f903b052fc78e759">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">faint</span><span class="commit-message" data-commit="0351015ad0b551194333cf7061928f14525eedc0">docs: replace %HOME% with %USERPROFILE% for Windows (#6482)</span><span class="snapshot-sha sha" data-commit="0351015ad0b551194333cf7061928f14525eedc0">0351015ad</span><time datetime="2025-02-08T23:47:05+03:00" title="2025-02-08 23:47:05 +0300">2025-02-08</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.1</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a class="current" href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.1/tree/docs/config/">config</a> / <span class="cur">files.md</span></nav>
<span class="view-stats"><span>6.7 KiB</span><span>215 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/1a11e95928644554adeb5fe6852b3a1bcca7f9fb/docs/config/files.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h2>Quick Start</h2>
<p>Create a file named <code>.wezterm.lua</code> in your home directory, with the following
contents:</p>
<pre class="language-lua"><a-c>-- Pull in the wezterm API</a-c>
<a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-c>-- This will hold the configuration.</a-c>
<a-k>local</a-k> <a-v>config</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>config_builder</a-f><a-p>()</a-p>

<a-c>-- This is where you actually apply your config choices</a-c>

<a-c>-- For example, changing the color scheme:</a-c>
<a-v>config</a-v><a-p>.</a-p><a-v>color_scheme</a-v> = <a-s>&#39;AdventureTime&#39;</a-s>

<a-c>-- and finally, return the configuration to wezterm</a-c>
<a-k>return</a-k> <a-v>config</a-v></pre>
<h2>Configuration Files</h2>
<p><code>wezterm</code> will look for a <a href="https://www.lua.org/manual/5.3/manual.html">lua</a>
configuration file using the logic shown below.</p>
<p>!!! tip
The recommendation is to place your configuration file at <code>$HOME/.wezterm.lua</code>
(<code>%USERPROFILE%/.wezterm.lua</code> on Windows) to get started.</p>
<p>More complex configurations that need to span multiple files can be placed in
<code>$XDG_CONFIG_HOME/wezterm/wezterm.lua</code> (for X11/Wayland) or
<code>$HOME/.config/wezterm/wezterm.lua</code> (for all other systems).</p>
<p>{% raw %}</p>
<pre>graph TD
  X[Locate Configuration file] --&gt; A{{--config-file CLI argument specified?}}
  A --&gt;|Yes| B{{Can that file be loaded?}}
  B --&gt;|Yes| C[Use it]
  B --&gt;|No| D[Use built-in default configuration]
  A --&gt;|No| E{{$WEZTERM_CONFIG_FILE&lt;br/&gt;environment set?}}
  E --&gt;|Yes| B
  E --&gt;|No| F{{&quot;Running on Windows and&lt;br/&gt;wezterm.lua exists in same&lt;br/&gt;dir as wezterm.exe?&lt;br/&gt;(Thumb drive mode)&quot;}}
  F --&gt;|Yes| B
  F --&gt;|No| H{{Is $XDG_CONFIG_HOME&lt;br/&gt;environment set and&lt;br/&gt;wezterm/wezterm.lua&lt;br/&gt;exists inside it?}}
  H --&gt;|Yes| B
  J --&gt; B
  H --&gt;|No| K{{Does $HOME/.config/wezterm/wezterm.lua exist?}}
  K --&gt;|Yes| B
  K --&gt;|No| J[Use $HOME/.wezterm.lua]
</pre>
<p>{% endraw %}</p>
<p>Prior to version 20210314-114017-04b7cedd, if the candidate file exists but
failed to parse, wezterm would treat it as though it didn't exist and continue
to try other candidate file locations. In all current versions of wezterm, an
error will be shown and the default configuration will be used instead.</p>
<p>!!! note
On Windows, to support users that carry their wezterm application and
configuration around on a thumb drive, wezterm will look for the config file in
the same location as wezterm.exe.  That is shown in the chart above as thumb
drive mode.  It is <strong>not</strong> recommended to store your configs in that
location if you are not running off a thumb drive.</p>
<p><code>wezterm</code> 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 <code>CTRL+SHIFT+R</code> keyboard shortcut
to force the configuration to be reloaded.</p>
<p>!!! info
<strong>The configuration file may be evaluated multiple times for each wezterm
process</strong> 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.</p>
<h3>Configuration Overrides</h3>
<p>{{since('20210314-114017-04b7cedd')}}</p>
<p><code>wezterm</code> allows overriding configuration values via the command line; here are
a couple of examples:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>wezterm</a-pr> <a-co>--config</a-co> enable_scroll_bar=true
<a-o>$</a-o><a-f> </a-f><a-pr>wezterm</a-pr> <a-co>--config</a-co> <a-s>&#39;exit_behavior=&quot;Hold&quot;&#39;</a-s></pre>
<p>Configuration specified via the command line will always override the values
provided by the configuration file, even if the configuration file is reloaded.</p>
<p>Each window can have an additional set of window-specific overrides applied to
it by code in your configuration file.  That's useful for eg: setting
transparency or any other arbitrary option on a per-window basis.  Read the
<a href="/fork/wezterm/ref/termiz-0.23.1/blob/docs/config/lua/window/set_config_overrides.md">window:set_config_overrides</a> documentation
for more information and examples of how to use that functionality.</p>
<h2>Configuration File Structure</h2>
<p>The <code>wezterm.lua</code> 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 (and rather useless!) configuration file will look like
this:</p>
<pre class="language-lua"><a-k>return</a-k> <a-cr>{}</a-cr></pre>
<p>Throughout these docs you'll find configuration fragments that demonstrate
configuration and that look something like this:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>

<a-v>config</a-v><a-p>.</a-p><a-v>color_scheme</a-v> = <a-s>&#39;Batman&#39;</a-s>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>and perhaps another one like this:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>

<a-v>config</a-v><a-p>.</a-p><a-v>font</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>font</a-f> <a-s>&#39;JetBrains Mono&#39;</a-s>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>If you wanted to use both of these in the same file, you would merge them together
like this:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>

<a-v>config</a-v><a-p>.</a-p><a-v>font</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>font</a-f> <a-s>&#39;JetBrains Mono&#39;</a-s>
<a-v>config</a-v><a-p>.</a-p><a-v>color_scheme</a-v> = <a-s>&#39;Batman&#39;</a-s>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>For the sake of brevity in these docs, individual snippets may be shown as
just the config assignments:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>color_scheme</a-v> = <a-s>&#39;Batman&#39;</a-s></pre>
<h2>Making your own Lua Modules</h2>
<p>If you'd like to break apart your configuration into multiple files, you'll
be interested in this information.</p>
<p>The Lua <code>package.path</code> is configured with the following paths in this order:</p>
<ul>
<li>On Windows: a <code>wezterm_modules</code> dir in the same directory as <code>wezterm.exe</code>. This is for thumb drive mode, and is not recommended to be used otherwise.</li>
<li><code>~/.config/wezterm</code></li>
<li><code>~/.wezterm</code></li>
<li>A system specific set of paths which may (or may not!) find locally installed lua modules</li>
</ul>
<p>That means that if you wanted to break your config up into a <code>helpers.lua</code> file
you would place it in <code>~/.config/wezterm/helpers.lua</code> with contents like this:</p>
<pre class="language-lua"><a-c>-- I am helpers.lua and I should live in ~/.config/wezterm/helpers.lua</a-c>

<a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-c>-- This is the module table that we will export</a-c>
<a-k>local</a-k> <a-v>module</a-v> = <a-cr>{}</a-cr>

<a-c>-- This function is private to this module and is not visible</a-c>
<a-c>-- outside.</a-c>
<a-k>local</a-k> <a-k>function</a-k> <a-f>private_helper</a-f><a-p>()</a-p>
  <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_error</a-f> <a-s>&#39;hello!&#39;</a-s>
<a-k>end</a-k>

<a-c>-- define a function in the module table.</a-c>
<a-c>-- Only functions defined in `module` will be exported to</a-c>
<a-c>-- code that imports this module.</a-c>
<a-c>-- The suggested convention for making modules that update</a-c>
<a-c>-- the config is for them to export an `apply_to_config`</a-c>
<a-c>-- function that accepts the config object, like this:</a-c>
<a-k>function</a-k> <a-v>module</a-v><a-p>.</a-p><a-f>apply_to_config</a-f><a-p>(</a-p><a-v>config</a-v><a-p>)</a-p>
  <a-f>private_helper</a-f><a-p>()</a-p>

  <a-v>config</a-v><a-p>.</a-p><a-v>color_scheme</a-v> = <a-s>&#39;Batman&#39;</a-s>
<a-k>end</a-k>

<a-c>-- return our module table</a-c>
<a-k>return</a-k> <a-v>module</a-v></pre>
<p>and then in your <code>wezterm.lua</code>
you would use it like this:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>helpers</a-v> = <a-f>require</a-f> <a-s>&#39;helpers&#39;</a-s>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>
<a-v>helpers</a-v><a-p>.</a-p><a-f>apply_to_config</a-f><a-p>(</a-p><a-v>config</a-v><a-p>)</a-p>
<a-k>return</a-k> <a-v>config</a-v></pre>
<h2>Configuration Reference</h2>
<p>Continue browsing this section of the docs for an overview of the commonly
adjusted settings, or visit the <a href="lua/config/index.md">Lua Config Reference</a> for a more detailed list of possibilities.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>##</a-p> <a-tt>Quick Start</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">Create a file named `.wezterm.lua` in your home directory, with the following</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">contents:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>-- Pull in the wezterm API</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>-- This will hold the configuration.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>local </a-p><a-v>config</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>config_builder</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>-- This is where you actually apply your config choices</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>-- For example, changing the color scheme:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>config.</a-p><a-v>color_scheme</a-v><a-p> = </a-p><a-s>&#39;AdventureTime&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>-- and finally, return the configuration to wezterm</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>return </a-p><a-v>config</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>## </a-p><a-tt>Configuration Files</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>`wezterm` will look for a [lua](https://www.lua.org/manual/5.3/manual.html)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>configuration file using the logic shown below.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>!!! tip</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>    The recommendation is to place your configuration file at `$HOME/.wezterm.lua`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>    (`%USERPROFILE%/.wezterm.lua` on Windows) to get started.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>More complex configurations that need to span multiple files can be placed in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>`$XDG_CONFIG_HOME/wezterm/wezterm.lua` (for X11/Wayland) or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>`$HOME/.config/wezterm/wezterm.lua` (for all other systems).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>{% raw %}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>```</a-p><a-tl>mermaid</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>graph TD</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>  X[Locate Configuration file] --&gt; A{{--config-file CLI argument specified?}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>  A --&gt;|Yes| B{{Can that file be loaded?}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>  B --&gt;|Yes| C[Use it]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>  B --&gt;|No| D[Use built-in default configuration]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>  A --&gt;|No| E{{$WEZTERM_CONFIG_FILE&lt;br/&gt;environment set?}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>  E --&gt;|Yes| B</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>  E --&gt;|No| F{{&quot;Running on Windows and&lt;br/&gt;wezterm.lua exists in same&lt;br/&gt;dir as wezterm.exe?&lt;br/&gt;(Thumb drive mode)&quot;}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>  F --&gt;|Yes| B</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>  F --&gt;|No| H{{Is $XDG_CONFIG_HOME&lt;br/&gt;environment set and&lt;br/&gt;wezterm/wezterm.lua&lt;br/&gt;exists inside it?}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>  H --&gt;|Yes| B</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>  J --&gt; B</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>  H --&gt;|No| K{{Does $HOME/.config/wezterm/wezterm.lua exist?}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>  K --&gt;|Yes| B</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>  K --&gt;|No| J[Use $HOME/.wezterm.lua]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>{% endraw %}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>Prior to version 20210314-114017-04b7cedd, if the candidate file exists but</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>failed to parse, wezterm would treat it as though it didn&#39;t exist and continue</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>to try other candidate file locations. In all current versions of wezterm, an</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>error will be shown and the default configuration will be used instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>!!! note</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>    On Windows, to support users that carry their wezterm application and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    configuration around on a thumb drive, wezterm will look for the config file in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>    the same location as wezterm.exe.  That is shown in the chart above as thumb</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    drive mode.  It is **not** recommended to store your configs in that</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>    location if you are not running off a thumb drive.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>`wezterm` will watch the config file that it loads; if/when it changes, the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>configuration will be automatically reloaded and the majority of options will</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>take effect immediately.  You may also use the `CTRL+SHIFT+R` keyboard shortcut</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>to force the configuration to be reloaded.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>!!! info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    **The configuration file may be evaluated multiple times for each wezterm</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>    process** both at startup and in response to the configuration file being</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>    reloaded.  You should avoid taking actions in the main flow of the config file</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>    that have side effects; for example, unconditionally launching background</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>    processes can result in many of them being spawned over time if you launch</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>    many copies of wezterm, or are frequently reloading your config file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>### </a-p><a-tt>Configuration Overrides</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>{{since(&#39;20210314-114017-04b7cedd&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>`wezterm` allows overriding configuration values via the command line; here are</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>a couple of examples:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>$ </a-p><a-pr>wezterm</a-pr><a-p> </a-p><a-co>--config</a-co><a-p> enable_scroll_bar=true</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>$ </a-p><a-pr>wezterm</a-pr><a-p> </a-p><a-co>--config</a-co><a-p> </a-p><a-s>&#39;exit_behavior=&quot;Hold&quot;&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>Configuration specified via the command line will always override the values</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>provided by the configuration file, even if the configuration file is reloaded.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>Each window can have an additional set of window-specific overrides applied to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>it by code in your configuration file.  That&#39;s useful for eg: setting</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>transparency or any other arbitrary option on a per-window basis.  Read the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>[window:set_config_overrides](lua/window/set_config_overrides.md) documentation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>for more information and examples of how to use that functionality.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>## </a-p><a-tt>Configuration File Structure</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>The `wezterm.lua` configuration file is a lua script which allows for a high</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>degree of flexibility.   The script is expected to return a configuration</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>table, so a basic empty (and rather useless!) configuration file will look like</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>return </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>Throughout these docs you&#39;ll find configuration fragments that demonstrate</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>configuration and that look something like this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>local </a-p><a-v>config</a-v><a-p> = </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>config.</a-p><a-v>color_scheme</a-v><a-p> = </a-p><a-s>&#39;Batman&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>return </a-p><a-v>config</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>and perhaps another one like this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>local </a-p><a-v>config</a-v><a-p> = </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>config.</a-p><a-v>font</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>font</a-f><a-p> </a-p><a-s>&#39;JetBrains Mono&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>return </a-p><a-v>config</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>If you wanted to use both of these in the same file, you would merge them together</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>like this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>local </a-p><a-v>config</a-v><a-p> = </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>config.</a-p><a-v>font</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>font</a-f><a-p> </a-p><a-s>&#39;JetBrains Mono&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>config.</a-p><a-v>color_scheme</a-v><a-p> = </a-p><a-s>&#39;Batman&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>return </a-p><a-v>config</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>For the sake of brevity in these docs, individual snippets may be shown as</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>just the config assignments:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>config.</a-p><a-v>color_scheme</a-v><a-p> = </a-p><a-s>&#39;Batman&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>## </a-p><a-tt>Making your own Lua Modules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>If you&#39;d like to break apart your configuration into multiple files, you&#39;ll</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>be interested in this information.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>The Lua `package.path` is configured with the following paths in this order:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>* On Windows: a `wezterm_modules` dir in the same directory as `wezterm.exe`. This is for thumb drive mode, and is not recommended to be used otherwise.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>* `~/.config/wezterm`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>* `~/.wezterm`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>* A system specific set of paths which may (or may not!) find locally installed lua modules</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>That means that if you wanted to break your config up into a `helpers.lua` file</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>you would place it in `~/.config/wezterm/helpers.lua` with contents like this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"><a-p>-- I am helpers.lua and I should live in ~/.config/wezterm/helpers.lua</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>-- This is the module table that we will export</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>local </a-p><a-v>module</a-v><a-p> = </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>-- This function is private to this module and is not visible</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>-- outside.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>local </a-p><a-k>function</a-k><a-p> </a-p><a-f>private_helper</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"><a-p>  </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>log_error</a-f><a-p> </a-p><a-s>&#39;hello!&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>end</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p>-- define a function in the module table.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"><a-p>-- Only functions defined in `module` will be exported to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"><a-p>-- code that imports this module.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"><a-p>-- The suggested convention for making modules that update</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p>-- the config is for them to export an `apply_to_config`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"><a-p>-- function that accepts the config object, like this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"><a-p>function </a-p><a-v>module</a-v><a-p>.</a-p><a-f>apply_to_config</a-f><a-p>(</a-p><a-v>config</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"><a-p>  </a-p><a-f>private_helper</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"><a-p>  </a-p><a-v>config</a-v><a-p>.</a-p><a-v>color_scheme</a-v><a-p> = </a-p><a-s>&#39;Batman&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"><a-p>end</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"><a-p>-- return our module table</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"><a-p>return </a-p><a-v>module</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>and then in your `wezterm.lua`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"><a-p>you would use it like this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"><a-p>local </a-p><a-v>helpers</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;helpers&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"><a-p>local </a-p><a-v>config</a-v><a-p> = </a-p><a-cr>{}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"><a-p>helpers.</a-p><a-f>apply_to_config</a-f><a-p>(</a-p><a-v>config</a-v><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"><a-p>return </a-p><a-v>config</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"><a-p>## </a-p><a-tt>Configuration Reference</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text">Continue browsing this section of the docs for an overview of the commonly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text">adjusted settings, or visit the [Lua Config Reference](lua/config/index.md) for a more detailed list of possibilities.</span></span></pre></div></div>
</main>
</body>
</html>
