<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/wezterm.plugin/list.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="docs/config/lua/wezterm.plugin/list.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/wezterm.plugin/list.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="docs/config/lua/wezterm.plugin/list.md in fork/wezterm at termwiz-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="termwiz-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">Alec Clews</span><span class="commit-message" data-commit="2bf84fb1004024692c1c939928a318cbddabd550">Fix typo</span><span class="snapshot-sha sha" data-commit="2bf84fb1004024692c1c939928a318cbddabd550">2bf84fb10</span><time datetime="2024-09-28T18:59:37+10:00" title="2024-09-28 18:59:37 +1000">2024-09-28</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.1</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 class="current" 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/termwiz-0.23.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/wezterm.plugin/">wezterm.plugin</a> / <span class="cur">list.md</span></nav>
<span class="view-stats"><span>466 B</span><span>11 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/0297f6e8e300f35405597e5b5b450488997930eb/docs/config/lua/wezterm.plugin/list.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"><h1>list function</h1>
<p>{{since('20230320-124340-559cb7b0')}}</p>
<p>Will return a table array listing all the plugin repos in the plugin directory</p>
<p>Each entry has three fields:</p>
<ul>
<li><code>url</code>: The URL of the plugin repo, as provided to the <code>wezterm.plugin.require</code> function</li>
<li><code>component</code>: The encoded name of the plugin, derived from the repo URL</li>
<li><code>plugin_dir</code>: The absolute location of the plugin checkout in the Wezterm runtime directory. Use this to set the plugin path if needed</li>
</ul>
</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"><a-p>#</a-p> <a-tt>list function</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20230320-124340-559cb7b0&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Will return a table array listing all the plugin repos in the plugin directory</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">Each entry has three fields:</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-p>* </a-p>`url`: The URL of the plugin repo, as provided to the `wezterm.plugin.require` function</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>* </a-p>`component`: The encoded name of the plugin, derived from the repo URL</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>* </a-p>`plugin_dir`: The absolute location of the plugin checkout in the Wezterm runtime directory. Use this to set the plugin path if needed</span></span></pre></div></div>
</main>
</body>
</html>
