<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/config/launch_menu.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/config/launch_menu.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/config/launch_menu.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/config/launch_menu.md in fork/wezterm at termiz-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="termiz-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">Silas Bue Handgaard</span><span class="commit-message" data-commit="b9c34ce7c75ce7b701d626c9b383fd5bd4d34d36">fix: link to launcher menu</span><span class="snapshot-sha sha" data-commit="b9c34ce7c75ce7b701d626c9b383fd5bd4d34d36">b9c34ce7c</span><time datetime="2024-09-03T20:27:21+02:00" title="2024-09-03 20:27:21 +0200">2024-09-03</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-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 class="current" 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.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/config/">config</a> / <span class="cur">launch_menu.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>44 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/5f3188b0c4aa1cce40c1742056cfa411eac1f921/docs/config/lua/config/launch_menu.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"><hr />
<p>tags:</p>
<ul>
<li>spawn</li>
<li>launch_menu</li>
</ul>
<hr />
<h1><code>launch_menu</code></h1>
<p>{{since('20200503-171512-b13ef15f')}}</p>
<p>You can define your own entries for the <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/launch.md#the-launcher-menu">Launcher Menu</a>
using this configuration setting.  The snippet below adds two new entries to
the menu; one that runs the <code>top</code> program to monitor process activity and a
second one that explicitly launches the <code>bash</code> shell.</p>
<p>Each entry in <code>launch_menu</code> is an instance of a
<a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/SpawnCommand.md">SpawnCommand</a> object.</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>launch_menu</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>args</a-v> = <a-cr>{</a-cr> <a-s>&#39;top&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>{</a-cr>
    <a-c>-- Optional label to show in the launcher. If omitted, a label</a-c>
    <a-c>-- is derived from the `args`</a-c>
    <a-v>label</a-v> = <a-s>&#39;Bash&#39;</a-s><a-p>,</a-p>
    <a-c>-- The argument array to spawn.  If omitted the default program</a-c>
    <a-c>-- will be used as described in the documentation above</a-c>
    <a-v>args</a-v> = <a-cr>{</a-cr> <a-s>&#39;bash&#39;</a-s><a-p>,</a-p> <a-s>&#39;-l&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>

    <a-c>-- You can specify an alternative current working directory;</a-c>
    <a-c>-- if you don&#39;t specify one then a default based on the OSC 7</a-c>
    <a-c>-- escape sequence will be used (see the Shell Integration</a-c>
    <a-c>-- docs), falling back to the home directory.</a-c>
    <a-c>-- cwd = &quot;/some/path&quot;</a-c>

    <a-c>-- You can override environment variables just for this command</a-c>
    <a-c>-- by setting this here.  It has the same semantics as the main</a-c>
    <a-c>-- set_environment_variables configuration option described above</a-c>
    <a-c>-- set_environment_variables = { FOO = &quot;bar&quot; },</a-c>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></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></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-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">  <a-p>-</a-p> <a-s>spawn</a-s></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-p>-</a-p> <a-s>launch_menu</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>---</a-p></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-p>#</a-p> <a-tt>`launch_menu`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">{{since(&#39;20200503-171512-b13ef15f&#39;)}}</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">You can define your own entries for the [Launcher Menu](../../launch.md#the-launcher-menu)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">using this configuration setting.  The snippet below adds two new entries to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">the menu; one that runs the `top` program to monitor process activity and a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">second one that explicitly launches the `bash` shell.</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">Each entry in `launch_menu` is an instance of a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">[SpawnCommand](../SpawnCommand.md) object.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></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><a-tl>lua</a-tl></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>config.</a-p><a-v>launch_menu</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="L20" href="#L20">20</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></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><a-v>args</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;top&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><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"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></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-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    </a-p><a-c>-- Optional label to show in the launcher. If omitted, a label</a-c></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-p><a-c>-- is derived from the `args`</a-c></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>    </a-p><a-v>label</a-v><a-p> = </a-p><a-s>&#39;Bash&#39;</a-s><a-p>,</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"><a-p>    </a-p><a-c>-- The argument array to spawn.  If omitted the default program</a-c></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><a-c>-- will be used as described in the documentation above</a-c></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>    </a-p><a-v>args</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;bash&#39;</a-s><a-p>, </a-p><a-s>&#39;-l&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>    </a-p><a-c>-- You can specify an alternative current working directory;</a-c></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>    </a-p><a-c>-- if you don&#39;t specify one then a default based on the OSC 7</a-c></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>    </a-p><a-c>-- escape sequence will be used (see the Shell Integration</a-c></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>    </a-p><a-c>-- docs), falling back to the home directory.</a-c></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>    </a-p><a-c>-- cwd = &quot;/some/path&quot;</a-c></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-c>-- You can override environment variables just for this command</a-c></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>    </a-p><a-c>-- by setting this here.  It has the same semantics as the main</a-c></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>    </a-p><a-c>-- set_environment_variables configuration option described above</a-c></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-p><a-c>-- set_environment_variables = { FOO = &quot;bar&quot; },</a-c></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>  </a-p><a-cr>}</a-cr><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"><a-p>}</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-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"></span></span></pre></div></div>
</main>
</body>
</html>
