<!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/require.md - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/config/lua/wezterm.plugin/require.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/wezterm.plugin/require.md - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/config/lua/wezterm.plugin/require.md in fork/wezterm at termwiz-0.23.3.">
<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.3" data-tip="4bf28e253c0167102f07bfc7e7199c13eed98012">
<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="20a44962d6cb0f6ef15e1072b01aea0b2119ec9b">Add reference material for plugin module</span><span class="snapshot-sha sha" data-commit="20a44962d6cb0f6ef15e1072b01aea0b2119ec9b">20a44962d</span><time datetime="2024-09-25T13:43:35+10:00" title="2024-09-25 13:43:35 +1000">2024-09-25</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.3</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 href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a class="current" 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.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/wezterm.plugin/">wezterm.plugin</a> / <span class="cur">require.md</span></nav>
<span class="view-stats"><span>606 B</span><span>18 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/1f067b1bb1dad3ae71f66484620f9f0edc1886ba/docs/config/lua/wezterm.plugin/require.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>Function require</h1>
<p>{{since('20230320-124340-559cb7b0')}}</p>
<p>Will clone the plugin repo if it doesn't already
exist and store it in the runtime dir under <code>plugins/NAME</code> where
<code>NAME</code> is derived from the repo URL. Once cloned, the repo is
NOT automatically updated when <code>require</code> is called again.</p>
<p>The function takes a single string parameter, the Git repo URL</p>
<p>Only HTTP(S) or local filesystem repos are allowed for the git URL.</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>remote_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>local_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;file:///Users/developer/projects/my.Plugin&#39;</a-s></pre>
</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>Function require</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 clone the plugin repo if it doesn&#39;t already</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">exist and store it in the runtime dir under `plugins/NAME` where</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">`NAME` is derived from the repo URL. Once cloned, the repo is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">NOT automatically updated when `require` is called again.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">The function takes a single string parameter, the Git 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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">Only HTTP(S) or local filesystem repos are allowed for the git URL.</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>```</a-p><a-tl>lua</a-tl></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>local </a-p><a-v>remote_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="L16" href="#L16">16</a><span class="code-text"><a-p>local </a-p><a-v>local_plugin</a-v><a-p> =</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>  </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;file:///Users/developer/projects/my.Plugin&#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"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
