<!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 @ v1.6.0</title>
<meta name="description" content="book/src/cli-installation.md in fork/numbat at v1.6.0.">
<meta property="og:title" content="book/src/cli-installation.md - fork/numbat @ v1.6.0">
<meta property="og:description" content="book/src/cli-installation.md in fork/numbat at v1.6.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="v1.6.0" data-tip="7b5a850e7da74758ace2b3751af0de349c60dbae">
<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="91c40dbab8538c9513a5cb56b570212de3cd6929">Preparations for web version</span><span class="snapshot-sha sha" data-commit="91c40dbab8538c9513a5cb56b570212de3cd6929">91c40db</span><time datetime="2023-09-20T12:46:57+02:00" title="2023-09-20 12:46:57 +0200">2023-09-20</time></p>
<header class="topbar"><details class="switcher"><summary>v1.6.0</summary><div class="menu"><strong>branches</strong><a href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a class="current" 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/v1.6.0/tree/book/">book</a> / <a href="/fork/numbat/ref/v1.6.0/tree/book/src/">src</a> / <span class="cur">cli-installation.md</span></nav>
<span class="view-stats"><span>659 B</span><span>30 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/1e4f6021852b15a7ddf0fa2639faa7044b36bb7b/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>
<p>Numbat does not have an official release yet,
but you can try out a pre-release version.</p>
<h2>Linux</h2>
<p>On Linux, you can call</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-sSf</a-co> https://numbat.dev/try.sh <a-o>|</a-o> <a-f>sh</a-f></pre>
<p>to try it immediately (unpacks to <code>/tmp</code> and executes from there).</p>
<p>For a proper installation, download the latest beta release
<a href="http://numbat.dev/numbat.zip">here</a>.</p>
<p>Then unpack the archive and move the <code>modules/</code> folder to <code>~/.config/numbat</code>
(create this folder if it does not exist)</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>
</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">Numbat does not have an official release yet,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">but you can try out a pre-release version.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</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="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">On Linux, you can call</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><a-tl> bash</a-tl></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>curl </a-p><a-co>-sSf</a-co><a-p> https://numbat.dev/try.sh </a-p><a-o>|</a-o><a-p> </a-p><a-f>sh</a-f></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></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>to try it immediately (unpacks to `/tmp` and executes from there).</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>For a proper installation, download the latest beta release</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>[here](http://numbat.dev/numbat.zip).</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>Then unpack the archive and move the `modules/` folder to `~/.config/numbat`</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>(create this folder if it does not exist)</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"></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><a-tt>From source</a-tt></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"><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="L25" href="#L25">25</a><span class="code-text"></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>```</a-p><a-tl> bash</a-tl></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>git clone https://github.com/sharkdp/numbat</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>cd numbat/</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"><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="L30" href="#L30">30</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
