<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/cli/general.md - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/cli/general.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/cli/general.md - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/cli/general.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">occupyhabit</span><span class="commit-message" data-commit="72e723187ca3596b67bcd3786457234ed40c75d2">chore: remove redundant words in comment</span><span class="snapshot-sha sha" data-commit="72e723187ca3596b67bcd3786457234ed40c75d2">72e723187</span><time datetime="2024-12-03T11:14:47+08:00" title="2024-12-03 11:14:47 +0800">2024-12-03</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/cli/">cli</a> / <span class="cur">general.md</span></nav>
<span class="view-stats"><span>1.2 KiB</span><span>31 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/c565a0ed550eba7bcd04d6fcf57f218f2a077e53/docs/cli/general.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>Command Line</h1>
<p>This section documents the wezterm command line.</p>
<p><em>Note that <code>wezterm --help</code> or <code>wezterm SUBCOMMAND --help</code> will show the precise
set of options that are applicable to your installed version of wezterm.</em></p>
<p>wezterm is deployed with two major executables:</p>
<ul>
<li><code>wezterm</code> (or <code>wezterm.exe</code> on Windows) - for interacting with wezterm from the terminal</li>
<li><code>wezterm-gui</code> (or <code>wezterm-gui.exe</code> on Windows) - for spawning wezterm from a desktop environment</li>
</ul>
<p>You will typically use <code>wezterm</code> when scripting wezterm; it knows when to
delegate to <code>wezterm-gui</code> under the covers.</p>
<p>If you are setting up a launcher for wezterm to run in the Windows GUI
environment then you will want to explicitly target <code>wezterm-gui</code> so that
Windows itself doesn't pop up a console host for its logging output.</p>
<p>!!! note
<code>wezterm-gui.exe --help</code> will not output anything to a console when
run on Windows systems, because it runs in the Windows GUI subsystem and has no
connection to the console.  You can use <code>wezterm.exe --help</code> to see information
about the various commands; it will delegate to <code>wezterm-gui.exe</code> when
appropriate.</p>
<h2>Synopsis</h2>
<pre class="language-bash">{<a-f>%</a-f> include <a-s>&quot;../examples/cmd-synopsis-wezterm--help.txt&quot;</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>Command Line</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">This section documents the wezterm command line.</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">*Note that `wezterm --help` or `wezterm SUBCOMMAND --help` will show the precise</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">set of options that are applicable to your installed version of wezterm.*</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">wezterm is deployed with two major executables:</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"><a-p>* </a-p>`wezterm` (or `wezterm.exe` on Windows) - for interacting with wezterm from the terminal</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>`wezterm-gui` (or `wezterm-gui.exe` on Windows) - for spawning wezterm from a desktop environment</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-p>You will typically use `wezterm` when scripting wezterm; it knows when to</a-p></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>delegate to `wezterm-gui` under the covers.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></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>If you are setting up a launcher for wezterm to run in the Windows GUI</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>environment then you will want to explicitly target `wezterm-gui` so that</a-p></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>Windows itself doesn&#39;t pop up a console host for its logging output.</a-p></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"><a-p>!!! note</a-p></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>    `wezterm-gui.exe --help` will not output anything to a console when</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>    run on Windows systems, because it runs in the Windows GUI subsystem and has no</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>    connection to the console.  You can use `wezterm.exe --help` to see information</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"><a-p>    about the various commands; it will delegate to `wezterm-gui.exe` when</a-p></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>    appropriate.</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>## </a-p><a-tt>Synopsis</a-tt></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"><a-p>```</a-p><a-tl>console</a-tl></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>{% include &quot;../examples/cmd-synopsis-wezterm--help.txt&quot; %}</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"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
