<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/plugins.md - fork/wezterm @ termwiz-0.23.2</title>
<meta name="description" content="docs/config/plugins.md in fork/wezterm at termwiz-0.23.2.">
<meta property="og:title" content="docs/config/plugins.md - fork/wezterm @ termwiz-0.23.2">
<meta property="og:description" content="docs/config/plugins.md in fork/wezterm at termwiz-0.23.2.">
<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="termwiz-0.23.2" data-tip="8b7ca454b5e0a65b69b1b736db54eae3c195384b">
<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">Alec Clews</span><span class="commit-message" data-commit="f541b0fe9c76265244b2c00164e7e36091fb7035">Changes after code review -- improve links and tips</span><span class="snapshot-sha sha" data-commit="f541b0fe9c76265244b2c00164e7e36091fb7035">f541b0fe9</span><time datetime="2024-09-28T18:44:53+10:00" title="2024-09-28 18:44:53 +1000">2024-09-28</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.2</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a 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 class="current" 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/termwiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/">config</a> / <span class="cur">plugins.md</span></nav>
<span class="view-stats"><span>4.7 KiB</span><span>144 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/dbf4f92e5fc1f65d2a3efcbb9ecdba39e006436d/docs/config/plugins.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>Introduction</h2>
&lt;!-- See also https://github.com/wez/wezterm/commit/e4ae8a844d8feaa43e1de34c5cc8b4f07ce525dd --&gt;
<p>A Wezterm plugin is a package of Lua files that provide
some some predefined functionality not in the core product.</p>
<p>A plugin is distributed via a Git URL.</p>
<p>!!! Tip</p>
<pre><code>Michael Brusegard maintains a [list of plugins](https://github.com/michaelbrusegard/awesome-wezterm)
</code></pre>
<h2>Installing a Plugin</h2>
<p>Brief example:</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>a_plugin</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>require</a-f> <a-s>&#39;https://github.com/owner/repo&#39;</a-s>

<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-v>a_plugin</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>
<p>The plugin URL must use the <code>HTTPS</code> or <code>file</code> <a href="https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols">protocol</a>.</p>
<p>When Wezterm clones the repo into the runtime directory the default branch (probably <code>main</code>)
is checked out and used as the plugin source.</p>
<p>Plugins can be configured, for example:</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>a_plugin</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>require</a-f> <a-s>&#39;https://github.com/owner/repo&#39;</a-s>

<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-k>local</a-k> <a-v>myPluginConfig</a-v> = <a-cr>{</a-cr> <a-v>enable</a-v> = <a-co>true</a-co><a-p>,</a-p> <a-v>location</a-v> = <a-s>&#39;right&#39;</a-s> <a-cr>}</a-cr>

<a-v>a_plugin</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-v>myPluginConfig</a-v><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>!!! Note</p>
<pre><code>Consult the README for a particular plugin to discover any specific configuration options.
</code></pre>
<h2>Updating Plugins</h2>
<p>When changes are published to a plugin repository they are not updated in the local Wezterm instance.</p>
<p>Run the command <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/wezterm.plugin/update_all.md"><code>wezterm.plugin.update_all()</code></a> to update all local plugins.</p>
<p>!!! Tip</p>
<pre><code>This can be run using the Lua REPL in [DebugOverlay](../troubleshooting.md#debug-overlay).
</code></pre>
<h2>Removing a Plugin</h2>
<p>When a plugin is first referenced, <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/wezterm.plugin/require.md"><code>wezterm.plugin.require()</code></a> will clone the repo if it doesn't already
exist and store it in the runtime directory under <code>plugins/NAME</code> where
<code>NAME</code> is derived from the repo URL.</p>
<p>You can discover locations of the various plugins with <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/wezterm.plugin/list.md"><code>wezterm.plugin.list()</code></a>.</p>
<p>To remove the plugin simply delete the appropriate plugin directory.</p>
<h2>Developing a Plugin</h2>
<ol>
<li>Create a local development repo</li>
<li>Add a file <code>plugin/init.lua</code></li>
<li><code>init.lua</code> must return a module that exports an <code>apply_to_config</code>
function. This function must accept at least a config builder parameter, but may
pass other parameters, or a Lua table with a <code>config</code> field that maps
to a config build parameter</li>
<li>Add any other Lua code needed to fulfil the plugin feature set.</li>
<li>Add the plugin using a local file url e.g.<pre class="language-lua"><a-k>local</a-k> <a-v>a_plugin</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>require</a-f> <a-s>&quot;file:///home/user/projects/myPlugin&quot;</a-s></pre>
</li>
</ol>
<p>!!! Info
When changes are made to the local project, <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/wezterm.plugin/update_all.md"><code>wezterm.plugin.update_all()</code></a> must be run
to sync the changes into the Wezterm runtime directory for testing and use.</p>
<p>!!! Info
This assumes development on the repo default branch (i.e. <code>main</code>). To use a different
development branch see below.</p>
<h3>Managing a Plugin with Multiple Lua Modules</h3>
<p>When <code>requiring</code> other Lua modules in your plugin the value of <code>package.path</code> needs to updated
with the location of the plugin. The plugin directory can be obtained by running
<code>wezterm.plugin.list()</code>. This function returns an array of triplets. e.g.</p>
<pre>[
    {
        &quot;component&quot;: &quot;filesCssZssZssZsUserssZsdevelopersZsprojectssZsmysDsPlugin&quot;,
        &quot;plugin_dir&quot;: &quot;/Users/alec/Library/Application Support/wezterm/plugins/filesCssZssZssZsUserssZsalecsZsprojectssZsbarsDswezterm&quot;,
        &quot;url&quot;: &quot;file:///Users/developer/projects/my.Plugin&quot;,
    },
]
</pre>
<p>The package path can then be updated with the value of <code>plugin_dir</code>. For example:</p>
<pre class="language-lua"><a-k>function</a-k> <a-f>findPluginPackagePath</a-f><a-p>(</a-p><a-v>myProject</a-v><a-p>)</a-p>
  <a-k>local</a-k> <a-v>separator</a-v> = <a-v>package</a-v><a-p>.</a-p><a-v>config</a-v><a-p>:</a-p><a-f>sub</a-f><a-p>(</a-p><a-n>1</a-n><a-p>,</a-p> <a-n>1</a-n><a-p>)</a-p> <a-o>==</a-o> <a-s>&#39;\\&#39;</a-s> <a-k>and</a-k> <a-s>&#39;\\&#39;</a-s> <a-k>or</a-k> <a-s>&#39;/&#39;</a-s>
  <a-k>for</a-k> <a-v>_</a-v><a-p>,</a-p> <a-v>v</a-v> <a-k>in</a-k> <a-f>ipairs</a-f><a-p>(</a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>list</a-f><a-p>())</a-p> <a-k>do</a-k>
    <a-k>if</a-k> <a-v>v</a-v><a-p>.</a-p><a-v>url</a-v> <a-o>==</a-o> <a-v>myProject</a-v> <a-k>then</a-k>
      <a-k>return</a-k> <a-v>v</a-v><a-p>.</a-p><a-v>plugin_dir</a-v> <a-o>..</a-o> <a-v>separator</a-v> <a-o>..</a-o> <a-s>&#39;plugin&#39;</a-s> <a-o>..</a-o> <a-v>separator</a-v> <a-o>..</a-o> <a-s>&#39;?.lua&#39;</a-s>
    <a-k>end</a-k>
  <a-k>end</a-k>
  <a-c>--- #TODO Add error fail here</a-c>
<a-k>end</a-k>

<a-v>package</a-v><a-p>.</a-p><a-v>path</a-v> = <a-v>package</a-v><a-p>.</a-p><a-v>path</a-v>
  <a-o>..</a-o> <a-s>&#39;;&#39;</a-s>
  <a-o>..</a-o> <a-f>findPluginPackagePath</a-f> <a-s>&#39;file:///Users/developer/projects/my.Plugin&#39;</a-s></pre>
<p>!!! Tip
Review other published plugins to discover more details on how to structure a plugin project</p>
<h2>Making changes to a Existing Plugin</h2>
<ol>
<li>Remove the original plugin from Wezterm</li>
<li>Fork the plugin repo</li>
<li>Clone the repo to a local directory</li>
<li>Optionally set an <code>upstream</code> remote to the original plugin repo. This makes it easier it merge upstream changes</li>
<li>Create a new branch for development</li>
<li>Make the new branch the default branch with <code>git symbolic-ref HEAD refs/heads/mybranch</code></li>
<li>Set the <code>plugin_dir</code> if required (some plugins hard code the value of the plugin directory).</li>
<li>Add the plugin to Wezterm using the file protocol</li>
</ol>
<p>Proceed using the develop workflow above</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>Introduction</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"><a-c>&lt;!-- See also https://github.com/wez/wezterm/commit/e4ae8a844d8feaa43e1de34c5cc8b4f07ce525dd --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">A Wezterm plugin is a package of Lua files that provide</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">some some predefined functionality not in the core product.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></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 plugin is distributed via a Git URL.</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">!!! Tip</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-tl>    Michael Brusegard maintains a [list of plugins](https://github.com/michaelbrusegard/awesome-wezterm)</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>##</a-p> <a-tt>Installing a Plugin</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">Brief example:</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>```</a-p><a-tl>lua</a-tl></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>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="L21" href="#L21">21</a><span class="code-text"><a-p>local </a-p><a-v>a_plugin</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;https://github.com/owner/repo&#39;</a-s></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>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="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>a_plugin.</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="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</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="L28" href="#L28">28</a><span class="code-text"><a-p>```</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"></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>The plugin URL must use the `HTTPS` or `file` [protocol](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols).</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>When Wezterm clones the repo into the runtime directory the default branch (probably `main`)</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>is checked out and used as the plugin source.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>Plugins can be configured, for example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></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>lua</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>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="L39" href="#L39">39</a><span class="code-text"><a-p>local </a-p><a-v>a_plugin</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;https://github.com/owner/repo&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></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>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="L42" href="#L42">42</a><span class="code-text"></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>local </a-p><a-v>myPluginConfig</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>enable</a-v><a-p> = </a-p><a-co>true</a-co><a-p>, </a-p><a-v>location</a-v><a-p> = </a-p><a-s>&#39;right&#39;</a-s><a-p> </a-p><a-cr>}</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></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>a_plugin.</a-p><a-f>apply_to_config</a-f><a-p>(</a-p><a-v>config</a-v><a-p>, </a-p><a-v>myPluginConfig</a-v><a-p>)</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"></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>return </a-p><a-v>config</a-v></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>```</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"></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>!!! Note</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"></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-tl>    Consult the README for a particular plugin to discover any specific configuration options.</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></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>## </a-p><a-tt>Updating Plugins</a-tt></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>When changes are published to a plugin repository they are not updated in the local Wezterm instance.</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"></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>Run the command [`wezterm.plugin.update_all()`](lua/wezterm.plugin/update_all.md) to update all local plugins.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</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="L61" href="#L61">61</a><span class="code-text"></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-tl>    This can be run using the Lua REPL in [DebugOverlay](../troubleshooting.md#debug-overlay).</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></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>## </a-p><a-tt>Removing a Plugin</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></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>When a plugin is first referenced, [`wezterm.plugin.require()`](lua/wezterm.plugin/require.md) will clone the repo if it doesn&#39;t already</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"><a-p>exist and store it in the runtime directory under `plugins/NAME` where</a-p></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>`NAME` is derived from the repo URL.</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"></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>You can discover locations of the various plugins with [`wezterm.plugin.list()`](lua/wezterm.plugin/list.md).</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>To remove the plugin simply delete the appropriate plugin directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></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>## </a-p><a-tt>Developing a Plugin</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></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>1. Create a local development repo</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>2. Add a file `plugin/init.lua`</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>3. `init.lua` must return a module that exports an `apply_to_config`</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>   function. This function must accept at least a config builder parameter, but may</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"><a-p>   pass other parameters, or a Lua table with a `config` field that maps</a-p></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>   to a config build parameter</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>4. Add any other Lua code needed to fulfil the plugin feature set.</a-p></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>5. Add the plugin using a local file url e.g.</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"><a-p>   </a-p><a-tl>```lua</a-tl></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>   </a-p><a-k>local</a-k><a-tl> </a-tl><a-v>a_plugin</a-v><a-tl> = </a-tl><a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>require</a-f><a-tl> </a-tl><a-s>&quot;file:///home/user/projects/myPlugin&quot;</a-s></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-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>!!! Info</a-p></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>    When changes are made to the local project, [`wezterm.plugin.update_all()`](lua/wezterm.plugin/update_all.md) must be run</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>    to sync the changes into the Wezterm runtime directory for testing and use.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</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="L93" href="#L93">93</a><span class="code-text"><a-p>    This assumes development on the repo default branch (i.e. `main`). To use a different</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>    development branch see below.</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>### </a-p><a-tt>Managing a Plugin with Multiple Lua Modules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"></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>When `requiring` other Lua modules in your plugin the value of `package.path` needs to updated</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>with the location of the plugin. The plugin directory can be obtained by running</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>`wezterm.plugin.list()`. This function returns an array of triplets. e.g.</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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>[</a-p></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>    {</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>        &quot;component&quot;: &quot;filesCssZssZssZsUserssZsdevelopersZsprojectssZsmysDsPlugin&quot;,</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>        &quot;plugin_dir&quot;: &quot;/Users/alec/Library/Application Support/wezterm/plugins/filesCssZssZssZsUserssZsalecsZsprojectssZsbarsDswezterm&quot;,</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>        &quot;url&quot;: &quot;file:///Users/developer/projects/my.Plugin&quot;,</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"><a-p>    },</a-p></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></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>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>The package path can then be updated with the value of `plugin_dir`. For example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></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>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>function </a-p><a-f>findPluginPackagePath</a-f><a-p>(</a-p><a-v>myProject</a-v><a-p>)</a-p></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-k>local</a-k><a-p> </a-p><a-v>separator</a-v><a-p> = </a-p><a-v>package</a-v><a-p>.</a-p><a-v>config</a-v><a-p>:</a-p><a-f>sub</a-f><a-p>(</a-p><a-n>1</a-n><a-p>, </a-p><a-n>1</a-n><a-p>) </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;\\&#39;</a-s><a-p> </a-p><a-k>and</a-k><a-p> </a-p><a-s>&#39;\\&#39;</a-s><a-p> </a-p><a-k>or</a-k><a-p> </a-p><a-s>&#39;/&#39;</a-s></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>  </a-p><a-k>for</a-k><a-p> </a-p><a-v>_</a-v><a-p>, </a-p><a-v>v</a-v><a-p> </a-p><a-k>in</a-k><a-p> </a-p><a-f>ipairs</a-f><a-p>(</a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>plugin</a-v><a-p>.</a-p><a-f>list</a-f><a-p>()) </a-p><a-k>do</a-k></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>    </a-p><a-k>if</a-k><a-p> </a-p><a-v>v</a-v><a-p>.</a-p><a-v>url</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-v>myProject</a-v><a-p> </a-p><a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>      </a-p><a-k>return</a-k><a-p> </a-p><a-v>v</a-v><a-p>.</a-p><a-v>plugin_dir</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>separator</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39;plugin&#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>separator</a-v><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39;?.lua&#39;</a-s></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>    </a-p><a-k>end</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>  </a-p><a-k>end</a-k></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>  </a-p><a-c>--- #TODO Add error fail here</a-c></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>end</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>package.</a-p><a-v>path</a-v><a-p> = </a-p><a-v>package</a-v><a-p>.</a-p><a-v>path</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>  </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39;;&#39;</a-s></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-o>..</a-o><a-p> </a-p><a-f>findPluginPackagePath</a-f><a-p> </a-p><a-s>&#39;file:///Users/developer/projects/my.Plugin&#39;</a-s></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>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</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="L131" href="#L131">131</a><span class="code-text"><a-p>    Review other published plugins to discover more details on how to structure a plugin project</a-p></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>## </a-p><a-tt>Making changes to a Existing Plugin</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>1. Remove the original plugin from Wezterm</a-p></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>1. Fork the plugin repo</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>1. Clone the repo to a local directory</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"><a-p>1. Optionally set an `upstream` remote to the original plugin repo. This makes it easier it merge upstream changes</a-p></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>1. Create a new branch for development</a-p></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>1. Make the new branch the default branch with `git symbolic-ref HEAD refs/heads/mybranch`</a-p></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>1. Set the `plugin_dir` if required (some plugins hard code the value of the plugin directory).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>1. Add the plugin to Wezterm using the file protocol</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text">Proceed using the develop workflow above</span></span></pre></div></div>
</main>
</body>
</html>
