<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/gui-events/gui-startup.md - fork/wezterm @ vtparse-0.7.0</title>
<meta name="description" content="docs/config/lua/gui-events/gui-startup.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:title" content="docs/config/lua/gui-events/gui-startup.md - fork/wezterm @ vtparse-0.7.0">
<meta property="og:description" content="docs/config/lua/gui-events/gui-startup.md in fork/wezterm at vtparse-0.7.0.">
<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="vtparse-0.7.0" data-tip="3bfe6df191af37bc33fe5fe6de12a40f7067f101">
<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">mozumasu</span><span class="commit-message" data-commit="f1f87df0448830ed66589eb5540bec2d77546576">fix: docs typos</span><span class="snapshot-sha sha" data-commit="f1f87df0448830ed66589eb5540bec2d77546576">f1f87df04</span><time datetime="2024-09-01T21:30:12+09:00" title="2024-09-01 21:30:12 +0900">2024-09-01</time></p>
<header class="topbar"><details class="switcher"><summary>vtparse-0.7.0</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 href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a class="current" 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/vtparse-0.7.0/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/vtparse-0.7.0/tree/docs/config/lua/gui-events/">gui-events</a> / <span class="cur">gui-startup.md</span></nav>
<span class="view-stats"><span>3.2 KiB</span><span>116 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/8964918738afd573d0425389de01a0e6f3fa8002/docs/config/lua/gui-events/gui-startup.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><code>gui-startup</code></h1>
<p>{{since('20220624-141144-bd1b7c5d')}}</p>
<p>The <code>gui-startup</code> event is emitted once when the GUI server is starting up
when running the <code>wezterm start</code> subcommand.</p>
<p>It is triggered before any default program is started.</p>
<p>If no explicit program was passed to <code>wezterm start</code>, and if the
<code>gui-startup</code> event causes any panes to be created then those will take
precedence over the default program configuration and no additional default
program will be spawned.</p>
<p>This event is useful for starting a set of programs in a standard
configuration to save you the effort of doing it manually each time.</p>
<p>This event fires before <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/gui-events/gui-attached.md">gui-attached</a>.</p>
<p>This event does not fire for <code>wezterm connect</code> invocations.</p>
<p>{{since('20220807-113146-c2fee766')}}</p>
<p>The event receives an optional <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/SpawnCommand.md">SpawnCommand</a> argument that
corresponds to any arguments that may have been passed via <code>wezterm start</code>.
In earlier releases if you implemented this event, you would essentially
prevent <code>wezterm start -- something</code> from spawning <code>something</code>.</p>
<p>The intent is for you to use the information in the command object to
spawn a new window, but you can choose to use or ignore it as suits
your purpose.</p>
<p>This basic example splits an initial window into thirds:</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>mux</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>mux</a-v>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;gui-startup&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>cmd</a-v><a-p>)</a-p>
  <a-k>local</a-k> <a-v>tab</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>window</a-v> = <a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f><a-p>(</a-p><a-v>cmd</a-v> <a-k>or</a-k> <a-cr>{}</a-cr><a-p>)</a-p>
  <a-c>-- Create a split occupying the right 1/3 of the screen</a-c>
  <a-v>pane</a-v><a-p>:</a-p><a-f>split</a-f> <a-cr>{</a-cr> <a-v>size</a-v> = <a-n>0.3</a-n> <a-cr>}</a-cr>
  <a-c>-- Create another split in the right of the remaining 2/3</a-c>
  <a-c>-- of the space; the resultant split is in the middle</a-c>
  <a-c>-- 1/3 of the display and has the focus.</a-c>
  <a-v>pane</a-v><a-p>:</a-p><a-f>split</a-f> <a-cr>{</a-cr> <a-v>size</a-v> = <a-n>0.5</a-n> <a-cr>}</a-cr>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>This example creates a default window but makes it maximize on startup:</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>mux</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>mux</a-v>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;gui-startup&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>cmd</a-v><a-p>)</a-p>
  <a-k>local</a-k> <a-v>tab</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>window</a-v> = <a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f><a-p>(</a-p><a-v>cmd</a-v> <a-k>or</a-k> <a-cr>{}</a-cr><a-p>)</a-p>
  <a-v>window</a-v><a-p>:</a-p><a-f>gui_window</a-f><a-p>():</a-p><a-f>maximize</a-f><a-p>()</a-p>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>Here's a more elaborate example that configures two workspaces:</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>mux</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>mux</a-v>
<a-k>local</a-k> <a-v>config</a-v> = <a-cr>{}</a-cr>

<a-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;gui-startup&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>cmd</a-v><a-p>)</a-p>
  <a-c>-- allow `wezterm start -- something` to affect what we spawn</a-c>
  <a-c>-- in our initial window</a-c>
  <a-k>local</a-k> <a-v>args</a-v> = <a-cr>{}</a-cr>
  <a-k>if</a-k> <a-v>cmd</a-v> <a-k>then</a-k>
    <a-v>args</a-v> = <a-v>cmd</a-v><a-p>.</a-p><a-v>args</a-v>
  <a-k>end</a-k>

  <a-c>-- Set a workspace for coding on a current project</a-c>
  <a-c>-- Top pane is for the editor, bottom pane is for the build tool</a-c>
  <a-k>local</a-k> <a-v>project_dir</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>home_dir</a-v> <a-o>..</a-o> <a-s>&#39;/wezterm&#39;</a-s>
  <a-k>local</a-k> <a-v>tab</a-v><a-p>,</a-p> <a-v>build_pane</a-v><a-p>,</a-p> <a-v>window</a-v> = <a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f> <a-cr>{</a-cr>
    <a-v>workspace</a-v> = <a-s>&#39;coding&#39;</a-s><a-p>,</a-p>
    <a-v>cwd</a-v> = <a-v>project_dir</a-v><a-p>,</a-p>
    <a-v>args</a-v> = <a-v>args</a-v><a-p>,</a-p>
  <a-cr>}</a-cr>
  <a-k>local</a-k> <a-v>editor_pane</a-v> = <a-v>build_pane</a-v><a-p>:</a-p><a-f>split</a-f> <a-cr>{</a-cr>
    <a-v>direction</a-v> = <a-s>&#39;Top&#39;</a-s><a-p>,</a-p>
    <a-v>size</a-v> = <a-n>0.6</a-n><a-p>,</a-p>
    <a-v>cwd</a-v> = <a-v>project_dir</a-v><a-p>,</a-p>
  <a-cr>}</a-cr>
  <a-c>-- may as well kick off a build in that pane</a-c>
  <a-v>build_pane</a-v><a-p>:</a-p><a-f>send_text</a-f> <a-s>&#39;cargo build\n&#39;</a-s>

  <a-c>-- A workspace for interacting with a local machine that</a-c>
  <a-c>-- runs some docker containers for home automation</a-c>
  <a-k>local</a-k> <a-v>tab</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>,</a-p> <a-v>window</a-v> = <a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f> <a-cr>{</a-cr>
    <a-v>workspace</a-v> = <a-s>&#39;automation&#39;</a-s><a-p>,</a-p>
    <a-v>args</a-v> = <a-cr>{</a-cr> <a-s>&#39;ssh&#39;</a-s><a-p>,</a-p> <a-s>&#39;vault&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr>

  <a-c>-- We want to startup in the coding workspace</a-c>
  <a-v>mux</a-v><a-p>.</a-p><a-f>set_active_workspace</a-f> <a-s>&#39;coding&#39;</a-s>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-v>config</a-v></pre>
<p>See also:</p>
<ul>
<li><a href="../wezterm.mux/index.md">wezterm.mux</a></li>
<li><a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/lua/gui-events/gui-attached.md">gui-attached</a>.</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>`gui-startup`</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;20220624-141144-bd1b7c5d&#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">The `gui-startup` event is emitted once when the GUI server is starting up</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">when running the `wezterm start` subcommand.</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">It is triggered before any default program is started.</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">If no explicit program was passed to `wezterm start`, and if the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">`gui-startup` event causes any panes to be created then those will take</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">precedence over the default program configuration and no additional default</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">program will be spawned.</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">This event is useful for starting a set of programs in a standard</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">configuration to save you the effort of doing it manually each time.</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">This event fires before [gui-attached](gui-attached.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">This event does not fire for `wezterm connect` invocations.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">{{since(&#39;20220807-113146-c2fee766&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">The event receives an optional [SpawnCommand](../SpawnCommand.md) argument that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">corresponds to any arguments that may have been passed via `wezterm start`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">In earlier releases if you implemented this event, you would essentially</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">prevent `wezterm start -- something` from spawning `something`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">The intent is for you to use the information in the command object to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">spawn a new window, but you can choose to use or ignore it as suits</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">your purpose.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">This basic example splits an initial window into thirds:</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>```</a-p><a-tl>lua</a-tl></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>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="L37" href="#L37">37</a><span class="code-text"><a-p>local </a-p><a-v>mux</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>mux</a-v></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>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="L39" href="#L39">39</a><span class="code-text"></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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;gui-startup&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>cmd</a-v><a-p>)</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>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>tab</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>window</a-v><a-p> = </a-p><a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f><a-p>(</a-p><a-v>cmd</a-v><a-p> </a-p><a-k>or</a-k><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><a-c>-- Create a split occupying the right 1/3 of the screen</a-c></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><a-v>pane</a-v><a-p>:</a-p><a-f>split</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>size</a-v><a-p> = </a-p><a-n>0.3</a-n><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"><a-p>  </a-p><a-c>-- Create another split in the right of the remaining 2/3</a-c></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-p><a-c>-- of the space; the resultant split is in the middle</a-c></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>  </a-p><a-c>-- 1/3 of the display and has the focus.</a-c></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>  </a-p><a-v>pane</a-v><a-p>:</a-p><a-f>split</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>size</a-v><a-p> = </a-p><a-n>0.5</a-n><a-p> </a-p><a-cr>}</a-cr></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>end)</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>return </a-p><a-v>config</a-v></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>```</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"></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>This example creates a default window but makes it maximize on startup:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</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="L56" href="#L56">56</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="L57" href="#L57">57</a><span class="code-text"><a-p>local </a-p><a-v>mux</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>mux</a-v></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>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="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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;gui-startup&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>cmd</a-v><a-p>)</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"><a-p>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>tab</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>window</a-v><a-p> = </a-p><a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f><a-p>(</a-p><a-v>cmd</a-v><a-p> </a-p><a-k>or</a-k><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="L62" href="#L62">62</a><span class="code-text"><a-p>  </a-p><a-v>window</a-v><a-p>:</a-p><a-f>gui_window</a-f><a-p>():</a-p><a-f>maximize</a-f><a-p>()</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>end)</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"></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>return </a-p><a-v>config</a-v></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>```</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>Here&#39;s a more elaborate example that configures two workspaces:</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>```</a-p><a-tl>lua</a-tl></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>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="L72" href="#L72">72</a><span class="code-text"><a-p>local </a-p><a-v>mux</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>mux</a-v></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>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="L74" href="#L74">74</a><span class="code-text"></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>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;gui-startup&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>cmd</a-v><a-p>)</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>  </a-p><a-c>-- allow `wezterm start -- something` to affect what we spawn</a-c></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>  </a-p><a-c>-- in our initial window</a-c></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>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>args</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="L79" href="#L79">79</a><span class="code-text"><a-p>  </a-p><a-k>if</a-k><a-p> </a-p><a-v>cmd</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="L80" href="#L80">80</a><span class="code-text"><a-p>    </a-p><a-v>args</a-v><a-p> = </a-p><a-v>cmd</a-v><a-p>.</a-p><a-v>args</a-v></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-k>end</a-k></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>  </a-p><a-c>-- Set a workspace for coding on a current project</a-c></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-c>-- Top pane is for the editor, bottom pane is for the build tool</a-c></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-p> </a-p><a-v>project_dir</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>home_dir</a-v><a-p> </a-p><a-o>..</a-o><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="L86" href="#L86">86</a><span class="code-text"><a-p>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>tab</a-v><a-p>, </a-p><a-v>build_pane</a-v><a-p>, </a-p><a-v>window</a-v><a-p> = </a-p><a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>    </a-p><a-v>workspace</a-v><a-p> = </a-p><a-s>&#39;coding&#39;</a-s><a-p>,</a-p></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-v>cwd</a-v><a-p> = </a-p><a-v>project_dir</a-v><a-p>,</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>    </a-p><a-v>args</a-v><a-p> = </a-p><a-v>args</a-v><a-p>,</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-cr>}</a-cr></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><a-k>local</a-k><a-p> </a-p><a-v>editor_pane</a-v><a-p> = </a-p><a-v>build_pane</a-v><a-p>:</a-p><a-f>split</a-f><a-p> </a-p><a-cr>{</a-cr></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>    </a-p><a-v>direction</a-v><a-p> = </a-p><a-s>&#39;Top&#39;</a-s><a-p>,</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>    </a-p><a-v>size</a-v><a-p> = </a-p><a-n>0.6</a-n><a-p>,</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>    </a-p><a-v>cwd</a-v><a-p> = </a-p><a-v>project_dir</a-v><a-p>,</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"><a-p>  </a-p><a-cr>}</a-cr></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-c>-- may as well kick off a build in that pane</a-c></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>  </a-p><a-v>build_pane</a-v><a-p>:</a-p><a-f>send_text</a-f><a-p> </a-p><a-s>&#39;cargo build\n&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></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>  </a-p><a-c>-- A workspace for interacting with a local machine that</a-c></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>  </a-p><a-c>-- runs some docker containers for home automation</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>  </a-p><a-k>local</a-k><a-p> </a-p><a-v>tab</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>, </a-p><a-v>window</a-v><a-p> = </a-p><a-v>mux</a-v><a-p>.</a-p><a-f>spawn_window</a-f><a-p> </a-p><a-cr>{</a-cr></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-v>workspace</a-v><a-p> = </a-p><a-s>&#39;automation&#39;</a-s><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><a-v>args</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;ssh&#39;</a-s><a-p>, </a-p><a-s>&#39;vault&#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="L104" href="#L104">104</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="L105" href="#L105">105</a><span class="code-text"></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>  </a-p><a-c>-- We want to startup in the coding workspace</a-c></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>  </a-p><a-v>mux</a-v><a-p>.</a-p><a-f>set_active_workspace</a-f><a-p> </a-p><a-s>&#39;coding&#39;</a-s></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>end)</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"></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-v>config</a-v></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>See also:</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"></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>* [wezterm.mux](../wezterm.mux/index.md)</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>[gui-attached](gui-attached.md).</span></span></pre></div></div>
</main>
</body>
</html>
