<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/install/source.md - fork/wezterm @ termwiz-0.23.2</title>
<meta name="description" content="docs/install/source.md in fork/wezterm at termwiz-0.23.2.">
<meta property="og:title" content="docs/install/source.md - fork/wezterm @ termwiz-0.23.2">
<meta property="og:description" content="docs/install/source.md in fork/wezterm at termwiz-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="termwiz-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">Wez Furlong</span><span class="commit-message" data-commit="11c4b11669d9ce23d51afaf286b5383fbdc9794f">s,wez/wezterm,wezterm/wezterm,</span><span class="snapshot-sha sha" data-commit="11c4b11669d9ce23d51afaf286b5383fbdc9794f">11c4b1166</span><time datetime="2025-02-07T13:08:01-07:00" title="2025-02-07 13:08:01 -0700">2025-02-07</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-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 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 class="current" 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.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/install/">install</a> / <span class="cur">source.md</span></nav>
<span class="view-stats"><span>2.5 KiB</span><span>71 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/26080689fdfe04b9f7278100ef6c119fd52e47e2/docs/install/source.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"><h2>Installing from source</h2>
<p>If your system isn't covered by the pre-built packages then you can build it
for yourself.  WezTerm should run on any modern unix as well as Windows 10 and
macOS.</p>
<ul>
<li>Install <code>rustup</code> to get the <code>rust</code> compiler installed on your system.
<a href="https://www.rust-lang.org/en-US/install.html">Install rustup</a>.</li>
<li>Rust version 1.71 or later is required</li>
<li>Build in release mode: <code>cargo build --release</code></li>
<li>Run it via either <code>cargo run --release --bin wezterm</code> or <code>target/release/wezterm</code></li>
</ul>
<p>You will need a collection of support libraries; the <a href="https://github.com/wezterm/wezterm/blob/main/get-deps"><code>get-deps</code></a> script will
attempt to install them for you.  If it doesn't know about your system,
<a href="https://github.com/wezterm/wezterm/blob/main/CONTRIBUTING.md">please contribute instructions!</a>.</p>
<p>If you don't plan to submit a pull request to the wezterm repo, you can
download a smaller source tarball using these steps:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>curl</a-pr> https://sh.rustup.rs <a-co>-sSf</a-co> <a-o>|</a-o> <a-f>sh</a-f> <a-co>-s</a-co>
<a-o>$</a-o><a-f> </a-f><a-pr>curl</a-pr> <a-co>-LO</a-co> {{ src_stable }}
<a-o>$</a-o><a-f> </a-f><a-pr>tar</a-pr> <a-co>-xzf</a-co> {{ src_stable_asset }}
<a-o>$</a-o><a-f> </a-f><a-pr>cd</a-pr> {{ src_stable_dir }}
<a-o>$</a-o> <a-f>./get-deps</a-f>
<a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> build <a-co>--release</a-co>
<a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> run <a-co>--release</a-co> <a-co>--bin</a-co> wezterm <a-co>--</a-co> start</pre>
<p>Alternatively, use the full git repo:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>curl</a-pr> https://sh.rustup.rs <a-co>-sSf</a-co> <a-o>|</a-o> <a-f>sh</a-f> <a-co>-s</a-co>
<a-o>$</a-o><a-f> </a-f><a-pr>git</a-pr> clone <a-co>--depth=1</a-co> <a-co>--branch=main</a-co> <a-co>--recursive</a-co> https://github.com/wezterm/wezterm.git
<a-o>$</a-o><a-f> </a-f><a-pr>cd</a-pr> wezterm
<a-o>$</a-o><a-f> </a-f><a-pr>git</a-pr> submodule update <a-co>--init</a-co> <a-co>--recursive</a-co>
<a-o>$</a-o> <a-f>./get-deps</a-f>
<a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> build <a-co>--release</a-co>
<a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> run <a-co>--release</a-co> <a-co>--bin</a-co> wezterm <a-co>--</a-co> start</pre>
<p><strong>If you get an error about zlib then you most likely didn't initialize the submodules;
take a closer look at the instructions!</strong></p>
<h3>Building without Wayland support on Unix systems</h3>
<p>By default, support for both X11 and Wayland is included on Unix systems.
If your distribution has X11 but not Wayland, then you can build WezTerm without
Wayland support by changing the <code>build</code> invocation:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>cargo</a-pr> build <a-co>--release</a-co> <a-co>--no-default-features</a-co> <a-co>--features</a-co> vendored-fonts</pre>
<p>Building without X11 is not supported.</p>
<h3>Building on Windows</h3>
<p>When installing Rust, you must use select the MSVC version of Rust. It is the
only supported way to build wezterm.</p>
<p>On Windows, instead of using <code>get-deps</code>, the only other dependency that you need is
<a href="https://strawberryperl.com">Strawberry Perl</a>. You must ensure that you have
your <code>PATH</code> environment set up to find that particular <code>perl.exe</code> ahead of any
other perl that you may have installed on your system. This particular version
of perl is required to build openssl on Windows.</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>set</a-pr> PATH=c:\Strawberry\perl\bin;<a-f>%PATH%</a-f></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>Installing from source</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">If your system isn&#39;t covered by the pre-built packages then you can build it</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">for yourself.  WezTerm should run on any modern unix as well as Windows 10 and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">macOS.</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"><a-p>* </a-p>Install `rustup` to get the `rust` compiler installed on your system.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>  </a-p>[Install rustup](https://www.rust-lang.org/en-US/install.html).</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>Rust version 1.71 or later is required</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>Build in release mode: `cargo build --release`</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>Run it via either `cargo run --release --bin wezterm` or `target/release/wezterm`</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 need a collection of support libraries; the [`get-deps`](https://github.com/wezterm/wezterm/blob/main/get-deps) script will</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>attempt to install them for you.  If it doesn&#39;t know about your system,</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"><a-p>[please contribute instructions!](https://github.com/wezterm/wezterm/blob/main/CONTRIBUTING.md).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></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>If you don&#39;t plan to submit a pull request to the wezterm repo, you can</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>download a smaller source tarball using these steps:</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>```</a-p><a-tl>console</a-tl></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>$ curl https://sh.rustup.rs -sSf | sh -s</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>$ curl -LO {{ src_stable }}</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>$ tar -xzf {{ src_stable_asset }}</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>$ cd {{ src_stable_dir }}</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>$ ./get-deps</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"><a-p>$ cargo build --release</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>$ cargo run --release --bin wezterm -- start</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></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>Alternatively, use the full git repo:</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"></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-tl>console</a-tl></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>$ curl https://sh.rustup.rs -sSf | sh -s</a-p></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>$ git clone --depth=1 --branch=main --recursive https://github.com/wezterm/wezterm.git</a-p></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>$ cd wezterm</a-p></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>$ git submodule update --init --recursive</a-p></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>$ ./get-deps</a-p></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>$ cargo build --release</a-p></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>$ cargo run --release --bin wezterm -- start</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></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>**If you get an error about zlib then you most likely didn&#39;t initialize the submodules;</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>take a closer look at the instructions!**</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 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-tt>Building without Wayland support on Unix systems</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></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>By default, support for both X11 and Wayland is included on Unix systems.</a-p></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>If your distribution has X11 but not Wayland, then you can build WezTerm without</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"><a-p>Wayland support by changing the `build` invocation:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></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><a-tl>console</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>$ cargo build --release --no-default-features --features vendored-fonts</a-p></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>```</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>Building without X11 is not supported.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></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>### </a-p><a-tt>Building on Windows</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>When installing Rust, you must use select the MSVC version of Rust. It is the</a-p></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>only supported way to build wezterm.</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"></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>On Windows, instead of using `get-deps`, the only other dependency that you need is</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>[Strawberry Perl](https://strawberryperl.com). You must ensure that you have</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"><a-p>your `PATH` environment set up to find that particular `perl.exe` ahead of any</a-p></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>other perl that you may have installed on your system. This particular version</a-p></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>of perl is required to build openssl on Windows.</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>```</a-p><a-tl>console</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>$ set PATH=c:\Strawberry\perl\bin;%PATH%</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
