<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/cli-installation.md - fork/numbat @ master</title>
<meta name="description" content="book/src/cli-installation.md in fork/numbat at master.">
<meta property="og:title" content="book/src/cli-installation.md - fork/numbat @ master">
<meta property="og:description" content="book/src/cli-installation.md in fork/numbat at master.">
<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="master" data-tip="b070b880c8a713bac881084034ea6f0d857868ed">
<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/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">David Peter</span><span class="commit-message" data-commit="46f6b0e2943e3b2535eade9f7f277e88e7b10d08">Bump version to v1.11.0</span><span class="snapshot-sha sha" data-commit="46f6b0e2943e3b2535eade9f7f277e88e7b10d08">46f6b0e</span><time datetime="2024-03-09T22:14:33+01:00" title="2024-03-09 22:14:33 +0100">2024-03-09</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <a href="/fork/numbat/ref/master/tree/book/">book</a> / <a href="/fork/numbat/ref/master/tree/book/src/">src</a> / <span class="cur">cli-installation.md</span></nav>
<span class="view-stats"><span>5.4 KiB</span><span>155 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/07b522b84891333e771c6f167b0173332efa2354/book/src/cli-installation.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>Installation</h1>
<h2>Linux</h2>
<h3>Ubuntu</h3>
<p><em>... and other Debian-based Linux distributions.</em></p>
<p>Download the latest <code>.deb</code> package from <a href="https://github.com/sharkdp/numbat/releases">the release page</a>
and install it via <code>dpkg</code>. For example:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-LO</a-co> https://github.com/sharkdp/numbat/releases/download/v1.11.0/numbat_1.11.0_amd64.deb
<a-f>sudo</a-f> dpkg <a-co>-i</a-co> numbat_1.11.0_amd64.deb</pre>
<p>Alternatively, if you want automatic updates, you can use a community-maintained <a href="https://launchpad.net/~apandada1/+archive/ubuntu/numbat">Numbat PPA</a>. The PPA only hosts packages for the <code>amd64</code>/<code>x86_64</code> architecture.</p>
<pre>sudo add-apt-repository ppa:apandada1/numbat
sudo apt update
sudo apt install numbat
</pre>
<h3>Arch Linux</h3>
<p>In Arch Linux and Arch based distributions, you can install the
<a href="https://aur.archlinux.org/packages/numbat-bin">prebuilt package of Numbat</a> from the AUR for the <code>x86_64</code> architecture:</p>
<pre class="language-bash"><a-f>yay</a-f> <a-co>-S</a-co> numbat-bin</pre>
<p>You can also install the <a href="https://aur.archlinux.org/packages/numbat">numbat</a>
AUR package, which will download the source and compile it. It works on all architectures.</p>
<pre class="language-bash"><a-f>yay</a-f> <a-co>-S</a-co> numbat</pre>
<h3>Void Linux</h3>
<p>You can install the <code>numbat</code> package using</p>
<pre class="language-bash"><a-f>sudo</a-f> xbps-install <a-co>-S</a-co> numbat</pre>
<h3>Chimera Linux</h3>
<p>Chimera Linux has a <code>numbat</code> package in its <code>contrib</code> repo. <a href="https://chimera-linux.org/docs/apk#repositories">Enable it if you
haven't already</a>, then install
<code>numbat</code>:</p>
<pre class="language-bash"><a-f>doas</a-f> apk add numbat</pre>
<h2>macOS</h2>
<h3>Homebrew</h3>
<p>You can install Numbat with Homebrew:</p>
<pre class="language-bash"><a-f>brew</a-f> install numbat</pre>
<h2>Windows</h2>
<h3>Scoop</h3>
<p>You can install the <a href="https://scoop.sh/#/apps?q=numbat">numbat</a> package using <a href="https://scoop.sh/">scoop</a>:</p>
<pre class="language-bash"><a-f>scoop</a-f> install main/numbat</pre>
<h2>NixOS</h2>
<p><em>... or any distribution where Nix is installed.</em></p>
<p>Install <a href="https://search.nixos.org/packages?channel=unstable&amp;show=numbat&amp;from=0&amp;size=50&amp;sort=relevance&amp;type=packages&amp;query=numbat">numbat</a> to your profile:</p>
<pre class="language-bash"><a-f>nix-env</a-f> <a-co>-iA</a-co> nixpkgs.numbat</pre>
<p>Or add it to your NixOS Configuration:</p>
<pre class="language-nix"><a-v>environment</a-v><a-p>.</a-p><a-v>systemPackages</a-v> <a-p>=</a-p> <a-p>[</a-p>
  <a-v>pkgs</a-v><a-p>.</a-p><a-v>numbat</a-v>
<a-p>];</a-p></pre>
<h2>From pre-built binaries</h2>
<p>Download the latest release for your system from <a href="https://github.com/sharkdp/numbat/releases">this page</a>. Unpack
the archive and place the <code>numbat</code>/<code>numbat.exe</code> binary in a folder that is on your <code>PATH</code>.</p>
<p>Note that the <code>modules</code> folder that is included in the archives is not strictly required to run Numbat. It serves more
as a reference for interested users. However, if you want to get the best possible experience or if you are
a package maintainer, please follow <a href="/fork/numbat/ref/master/blob/book/src/cli-installation.md#guidelines-for-package-maintainers">these guidelines</a>.</p>
<h2>From source</h2>
<p>Clone the Git repository, and build Numbat with <code>cargo</code>:</p>
<pre class="language-bash"><a-f>git</a-f> clone https://github.com/sharkdp/numbat
<a-f>cd</a-f> numbat/
<a-f>cargo</a-f> install <a-co>-f</a-co> <a-co>--path</a-co> numbat-cli</pre>
<p>Or install the latest release using</p>
<pre class="language-bash"><a-f>cargo</a-f> install numbat-cli</pre>
<h2>Guidelines for package maintainers</h2>
<p>Thank you for packaging Numbat! This section contains instructions that are not strictly necessary
to create a Numbat package, but provide users with the best-possible experience on your target platform.</p>
<p>Numbat has a <a href="/fork/numbat/ref/master/blob/book/src/prelude.md">standard library</a> that is written in Numbat itself. The sources for this
so called "prelude" are available in the <a href="https://github.com/sharkdp/numbat/tree/master/numbat/modules"><code>numbat/modules</code></a> folder.
We also include this <code>modules</code> folder in the pre-built <a href="https://github.com/sharkdp/numbat/releases">GitHub releases</a>.
Installing this folder as part of the package installation is not necessary for Numbat to work, as the prelude is also
stored inside the <code>numbat</code> binary. But ideally, this folder should be made available for users. There are three reasons for this:</p>
<ul>
<li>Users might want to look at the code in the standard library to get a better understanding of the language itself.</li>
<li>For some error messages, Numbat refers to locations in the source code. For example, if you type <code>let meter = 2</code>, the compiler
will let you know that this identifier is already in use, and has been previously defined at a certain location inside the
standard library. If the corresponding module is available as a file on the users system, they will see the proper path and
can read the corresponding file.</li>
<li>Users might want to make changes to the prelude. Ideally, this should be done via a <a href="/fork/numbat/ref/master/blob/book/src/cli-customization.md">user module folder</a>,
but the system-wide folder can serve as a template.</li>
</ul>
<p>In order for this to work, the <code>modules</code> folder should ideally be placed in the <a href="/fork/numbat/ref/master/blob/book/src/cli-customization.md">standard location for the
target operating system</a>. If this is not possible, package maintainers can customize
numbat during compilation by setting the environment variable <code>NUMBAT_SYSTEM_MODULE_PATH</code> to the final locatiom.
If this variable is set during compilation, the specified path will be compiled into the <code>numbat</code> binary.</p>
<p>In order to test that everything is working as intended, you can open <code>numbat</code> and type <code>let meter = 2</code>. The
path in the error message should point to the specified location (and <em>not</em> to <code>&lt;builtin&gt;/…</code>).</p>
<p>If your OS uses <code>.desktop</code> files, you should probably also install:</p>
<ul>
<li><code>assets/numbat.desktop</code> (typically to <code>/usr/share/applications</code>)</li>
<li><code>assets/numbat.svg</code> (typically to <code>/usr/share/icons/hicolor/scalable/apps</code>)</li>
<li><code>assets/numbat-*x*.png</code> (typically to e.g. <code>/usr/share/icons/hicolor/32x32/apps</code>, depending on each icon's size)</li>
</ul>
<p>This allows users to e.g. pin Numbat to GNOME's Dash.</p>
</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>Installation</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"><a-p>##</a-p> <a-tt>Linux</a-tt></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"><a-p>###</a-p> <a-tt>Ubuntu</a-tt></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">*... and other Debian-based Linux distributions.*</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">Download the latest `.deb` package from [the release page](https://github.com/sharkdp/numbat/releases)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">and install it via `dpkg`. For example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>```</a-p><a-tl> bash</a-tl></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>curl </a-p><a-co>-LO</a-co><a-p> https://github.com/sharkdp/numbat/releases/download/v1.11.0/numbat_1.11.0_amd64.deb</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>sudo dpkg </a-p><a-co>-i</a-co><a-p> numbat_1.11.0_amd64.deb</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>```</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>Alternatively, if you want automatic updates, you can use a community-maintained [Numbat PPA](https://launchpad.net/~apandada1/+archive/ubuntu/numbat). The PPA only hosts packages for the `amd64`/`x86_64` architecture.</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"></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></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>sudo add-apt-repository ppa:apandada1/numbat</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>sudo apt update</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>sudo apt install numbat</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></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>Arch Linux</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>In Arch Linux and Arch based distributions, you can install the</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>[prebuilt package of Numbat](https://aur.archlinux.org/packages/numbat-bin) from the AUR for the `x86_64` architecture:</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>```</a-p><a-tl> bash</a-tl></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>yay </a-p><a-co>-S</a-co><a-p> numbat-bin</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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></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>You can also install the [numbat](https://aur.archlinux.org/packages/numbat)</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>AUR package, which will download the source and compile it. It works on all architectures.</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"></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-tl> bash</a-tl></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>yay </a-p><a-co>-S</a-co><a-p> numbat</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>```</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"></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-tt>Void Linux</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></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>You can install the `numbat` package using</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-tl> bash</a-tl></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>sudo xbps-install </a-p><a-co>-S</a-co><a-p> numbat</a-p></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></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-tt>Chimera Linux</a-tt></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>Chimera Linux has a `numbat` package in its `contrib` repo. [Enable it if you</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"><a-p>haven&#39;t already](https://chimera-linux.org/docs/apk#repositories), then install</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>`numbat`:</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> bash</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>doas apk add numbat</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>```</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"></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>## </a-p><a-tt>macOS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></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-tt>Homebrew</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></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>You can install Numbat with Homebrew:</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>```</a-p><a-tl> bash</a-tl></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>brew install numbat</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></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-tt>Windows</a-tt></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 class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>### </a-p><a-tt>Scoop</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>You can install the [numbat](https://scoop.sh/#/apps?q=numbat) package using [scoop](https://scoop.sh/):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></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-tl> bash</a-tl></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>scoop install main/numbat</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></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-tt>NixOS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>*... or any distribution where Nix is installed.*</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></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>Install [numbat](https://search.nixos.org/packages?channel=unstable&amp;show=numbat&amp;from=0&amp;size=50&amp;sort=relevance&amp;type=packages&amp;query=numbat) to your profile:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></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-tl> bash</a-tl></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>nix-env </a-p><a-co>-iA</a-co><a-p> nixpkgs.numbat</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></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>Or add it to your NixOS Configuration:</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"></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-tl> nix</a-tl></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>environment.</a-p><a-v>systemPackages</a-v><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>pkgs</a-v><a-p>.</a-p><a-v>numbat</a-v></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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></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-tt>From pre-built binaries</a-tt></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>Download the latest release for your system from [this page](https://github.com/sharkdp/numbat/releases). Unpack</a-p></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>the archive and place the `numbat`/`numbat.exe` binary in a folder that is on your `PATH`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></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>Note that the `modules` folder that is included in the archives is not strictly required to run Numbat. It serves more</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>as a reference for interested users. However, if you want to get the best possible experience or if you are</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 package maintainer, please follow [these guidelines](./cli-installation.md#guidelines-for-package-maintainers).</a-p></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-tt>From source</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></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>Clone the Git repository, and build Numbat with `cargo`:</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>```</a-p><a-tl> bash</a-tl></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>git clone https://github.com/sharkdp/numbat</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"><a-p>cd numbat/</a-p></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>cargo install </a-p><a-co>-f</a-co><a-p> </a-p><a-co>--path</a-co><a-p> numbat-cli</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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></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>Or install the latest release using</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>```</a-p><a-tl> bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>cargo install numbat-cli</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>## </a-p><a-tt>Guidelines for package maintainers</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>Thank you for packaging Numbat! This section contains instructions that are not strictly necessary</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>to create a Numbat package, but provide users with the best-possible experience on your target platform.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>Numbat has a [standard library](./prelude.md) that is written in Numbat itself. The sources for this</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>so called &quot;prelude&quot; are available in the [`numbat/modules`](https://github.com/sharkdp/numbat/tree/master/numbat/modules) folder.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>We also include this `modules` folder in the pre-built [GitHub releases](https://github.com/sharkdp/numbat/releases).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>Installing this folder as part of the package installation is not necessary for Numbat to work, as the prelude is also</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>stored inside the `numbat` binary. But ideally, this folder should be made available for users. There are three reasons for this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>- Users might want to look at the code in the standard library to get a better understanding of the language itself.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>- For some error messages, Numbat refers to locations in the source code. For example, if you type `let meter = 2`, the compiler</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>  will let you know that this identifier is already in use, and has been previously defined at a certain location inside the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>  standard library. If the corresponding module is available as a file on the users system, they will see the proper path and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>  can read the corresponding file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>- Users might want to make changes to the prelude. Ideally, this should be done via a [user module folder](./cli-customization.md),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>  but the system-wide folder can serve as a template.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>In order for this to work, the `modules` folder should ideally be placed in the [standard location for the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>target operating system](./cli-customization.md). If this is not possible, package maintainers can customize</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>numbat during compilation by setting the environment variable `NUMBAT_SYSTEM_MODULE_PATH` to the final locatiom.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>If this variable is set during compilation, the specified path will be compiled into the `numbat` binary.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>In order to test that everything is working as intended, you can open `numbat` and type `let meter = 2`. The</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>path in the error message should point to the specified location (and *not* to `&lt;builtin&gt;/…`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>If your OS uses `.desktop` files, you should probably also install:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>- `assets/numbat.desktop` (typically to `/usr/share/applications`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>- `assets/numbat.svg` (typically to `/usr/share/icons/hicolor/scalable/apps`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>- `assets/numbat-*x*.png` (typically to e.g. `/usr/share/icons/hicolor/32x32/apps`, depending on each icon&#39;s size)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text">This allows users to e.g. pin Numbat to GNOME&#39;s Dash.</span></span></pre></div></div>
</main>
</body>
</html>
