<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/install/macos.md - fork/wezterm @ vtparse-0.7.0</title>
<meta name="description" content="docs/install/macos.md in fork/wezterm at vtparse-0.7.0.">
<meta property="og:title" content="docs/install/macos.md - fork/wezterm @ vtparse-0.7.0">
<meta property="og:description" content="docs/install/macos.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">Roy</span><span class="commit-message" data-commit="f0416016dc8f18e7930a0969de196f8973789425">chore: Updating docs for macOS Homebrew</span><span class="snapshot-sha sha" data-commit="f0416016dc8f18e7930a0969de196f8973789425">f0416016d</span><time datetime="2024-07-15T06:10:26-07:00" title="2024-07-15 06:10:26 -0700">2024-07-15</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/install/">install</a> / <span class="cur">macos.md</span></nav>
<span class="view-stats"><span>2.6 KiB</span><span>68 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/526a1f3503baa50d178c5f20e8df68f1c4809ee6/docs/install/macos.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 on macOS</h2>
<p>The CI system builds the package on macOS Big Sur and should run on systems as
"old" as Mojave.  It may run on earlier versions of macOS, but that has not
been tested.</p>
<p>Starting with version 20210203-095643-70a364eb, WezTerm is a Universal binary
with support for both Apple Silicon and Intel hardware.</p>
<p>[:simple-apple: Download for macOS :material-tray-arrow-down:]({{ macos_zip_stable }}){ .md-button }
[:simple-apple: Nightly for macOS :material-tray-arrow-down:]({{ macos_zip_nightly }}){ .md-button }</p>
<ol>
<li>Download &lt;a href="{{ macos_zip_stable }}"&gt;Release&lt;/a&gt;.</li>
<li>Extract the zipfile and drag the <code>WezTerm.app</code> bundle to your <code>Applications</code> folder.</li>
<li>First time around, you may need to right click and select <code>Open</code> to allow launching
the application that you've just downloaded from the internet.</li>
<li>Subsequently, a simple double-click will launch the UI.</li>
<li>To use wezterm binary from a terminal emulator, like <code>wezterm ls-fonts</code> you'll need to add the location to the wezterm binary folder that exists <em>inside</em> the WezTerm.app, to your environment's $PATH value. For example, to add it to your <code>~/.zshrc</code> file, and assuming your WezTerm.app was installed to <code>/Applications</code>, add:</li>
</ol>
<pre class="language-bash"><a-pr>PATH</a-pr>=<a-s>&quot;</a-s><a-o>$</a-o><a-pr>PATH</a-pr><a-s>:/Applications/WezTerm.app/Contents/MacOS&quot;</a-s>
<a-k>export</a-k> <a-pr>PATH</a-pr></pre>
<ol start="5">
<li>Configuration instructions can be <a href="/fork/wezterm/ref/vtparse-0.7.0/blob/docs/config/files.md">found here</a></li>
</ol>
<h2>Homebrew</h2>
<p>WezTerm is available for <a href="https://brew.sh/">brew</a> users:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>brew</a-pr> install <a-co>--cask</a-co> wezterm</pre>
<p>If you'd like to use a nightly build:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>brew</a-pr> install <a-co>--cask</a-co> wezterm@nightly</pre>
<p>!!! note
For users who have previously used the cask named <code>wezterm-nightly</code>,
homebrew has started issuing warnings: <code>Warning: Cask     homebrew/cask-versions/wezterm-nightly was renamed to wezterm@nightly</code>. We
recommend that you use <code>brew uninstall wezterm-nightly</code> to uninstall the
previously installed version, and then reinstall the new version using the
command above.</p>
<p>to upgrade to a newer nightly (normal <code>brew upgrade</code> will not upgrade it!):</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>brew</a-pr> upgrade <a-co>--cask</a-co> wezterm@nightly <a-co>--no-quarantine</a-co> <a-co>--greedy-latest</a-co></pre>
<p>!!! note
The <code>--greedy-latest</code> option in Homebrew forces the latest version of a
formula to be installed, even if a version satisfying the formula's
requirements is already installed. This can be useful when you want to
ensure you have the most up-to-date version of a package, regardless of
whether an older version meets the current dependency requirements.</p>
<h2>MacPorts</h2>
<p>WezTerm is also available via <a href="https://ports.macports.org/port/wezterm/summary">MacPorts</a>:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>sudo</a-pr> port selfupdate
<a-o>$</a-o><a-f> </a-f><a-pr>sudo</a-pr> port install wezterm</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 on macOS</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">The CI system builds the package on macOS Big Sur and should run on systems as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">&quot;old&quot; as Mojave.  It may run on earlier versions of macOS, but that has not</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">been tested.</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">Starting with version 20210203-095643-70a364eb, WezTerm is a Universal binary</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">with support for both Apple Silicon and Intel hardware.</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">[:simple-apple: Download for macOS :material-tray-arrow-down:]({{ macos_zip_stable }}){ .md-button }</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">[:simple-apple: Nightly for macOS :material-tray-arrow-down:]({{ macos_zip_nightly }}){ .md-button }</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>1. </a-p>Download &lt;a href=&quot;{{ macos_zip_stable }}&quot;&gt;Release&lt;/a&gt;.</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>2. </a-p>Extract the zipfile and drag the `WezTerm.app` bundle to your `Applications` folder.</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>3. </a-p>First time around, you may need to right click and select `Open` to allow launching</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>   </a-p>the application that you&#39;ve just downloaded from the internet.</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>3. </a-p>Subsequently, a simple double-click will launch the UI.</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>4. </a-p>To use wezterm binary from a terminal emulator, like `wezterm ls-fonts` you&#39;ll need to add the location to the wezterm binary folder that exists _inside_ the WezTerm.app, to your environment&#39;s $PATH value. For example, to add it to your `~/.zshrc` file, and assuming your WezTerm.app was installed to `/Applications`, add:</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>```</a-p><a-tl>sh</a-tl></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>PATH=&quot;$PATH:/Applications/WezTerm.app/Contents/MacOS&quot;</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>export PATH</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></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>5. Configuration instructions can be [found here](../config/files.md)</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"></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-tt>Homebrew</a-tt></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>WezTerm is available for [brew](https://brew.sh/) users:</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"></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>$ brew install --cask wezterm</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 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"><a-p>If you&#39;d like to use a nightly build:</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"></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>console</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>$ brew install --cask wezterm@nightly</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>```</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"></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>!!! note</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>    For users who have previously used the cask named `wezterm-nightly`,</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>    homebrew has started issuing warnings: `Warning: Cask</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>    homebrew/cask-versions/wezterm-nightly was renamed to wezterm@nightly`. We</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>    recommend that you use `brew uninstall wezterm-nightly` to uninstall the</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"><a-p>    previously installed version, and then reinstall the new version using the</a-p></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>    command above.</a-p></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>to upgrade to a newer nightly (normal `brew upgrade` will not upgrade it!):</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"></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>```</a-p><a-tl>console</a-tl></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>$ brew upgrade --cask wezterm@nightly --no-quarantine --greedy-latest</a-p></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>!!! note</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"><a-p>    The `--greedy-latest` option in Homebrew forces the latest version of a</a-p></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>    formula to be installed, even if a version satisfying the formula&#39;s</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"><a-p>    requirements is already installed. This can be useful when you want to</a-p></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>    ensure you have the most up-to-date version of a package, regardless of</a-p></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>    whether an older version meets the current dependency requirements.</a-p></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>## </a-p><a-tt>MacPorts</a-tt></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>WezTerm is also available via [MacPorts](https://ports.macports.org/port/wezterm/summary):</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"></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>```</a-p><a-tl>console</a-tl></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>$ sudo port selfupdate</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>$ sudo port install wezterm</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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
