<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/cli-usage.md - fork/numbat @ master</title>
<meta name="description" content="book/src/cli-usage.md in fork/numbat at master.">
<meta property="og:title" content="book/src/cli-usage.md - fork/numbat @ master">
<meta property="og:description" content="book/src/cli-usage.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="ec69a2506aafd713e4f02e02f73bac67962ae4b7">Add documentation</span><span class="snapshot-sha sha" data-commit="ec69a2506aafd713e4f02e02f73bac67962ae4b7">ec69a25</span><time datetime="2023-11-24T09:27:41+01:00" title="2023-11-24 09:27:41 +0100">2023-11-24</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-usage.md</span></nav>
<span class="view-stats"><span>1.8 KiB</span><span>62 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/715de709a1c4a98ceae5e2e9ab8b18418a056850/book/src/cli-usage.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>Usage</h1>
<h2>Modes</h2>
<p>You can run the Numbat command-line application in three different modes:</p>
<table><thead><tr><th>Mode</th><th>Command to run</th></tr></thead><tbody>
<tr><td>Start an interactive session (REPL)</td><td><code>numbat</code></td></tr>
<tr><td>Run a Numbat program</td><td><code>numbat script.nbt</code></td></tr>
<tr><td>Evaluate a single expression</td><td><code>numbat -e '30 km/h -&gt; mi/h'</code></td></tr>
</tbody></table>
<h2>Command-line options</h2>
<p>See <code>numbat --help</code> for more information.</p>
<h2>Interactive sessions</h2>
<p>Interactive sessions allow you to perform a sequence of calculations. You can use the special identifiers
<code>ans</code> or <code>_</code> to refer to the result of the last calculation. For example:</p>
<pre>&gt;&gt;&gt; 60 kW h / 150 kW

    = 0.4 h

&gt;&gt;&gt; ans -&gt; minutes

    = 24 min
</pre>
<h3>Commands</h3>
<p>There is a set of special commands that only work in interactive mode:</p>
<table><thead><tr><th>Command</th><th>Action</th></tr></thead><tbody>
<tr><td><code>list</code>, <code>ls</code></td><td>List all functions, dimensions, variables and units</td></tr>
<tr><td><code>list &lt;what&gt;</code></td><td>Where <code>&lt;what&gt;</code> can be <code>functions</code>, <code>dimensions</code>, <code>variables</code>, <code>units</code></td></tr>
<tr><td><code>info &lt;identifier&gt;</code></td><td>Get more information about units and variables</td></tr>
<tr><td><code>clear</code></td><td>Clear screen</td></tr>
<tr><td><code>help</code>, <code>?</code></td><td>View short help text</td></tr>
<tr><td><code>quit</code>, <code>exit</code></td><td>Quit the session</td></tr>
</tbody></table>
<h3>Key bindings</h3>
<p>In interactive command-line mode, you can use the following key bindings. Most importantly,
<code>Tab</code> for auto-completion, arrow keys and <code>Ctrl-R</code> for browsing the command history, and
<code>Ctrl-D</code> for exiting the interactive session.</p>
<table><thead><tr><th>Key sequence</th><th>Action</th></tr></thead><tbody>
<tr><td><code>Tab</code>, <code>Ctrl</code>-<code>I</code></td><td>Auto-completion</td></tr>
<tr><td><code>Ctrl</code>-<code>D</code></td><td>Quit</td></tr>
<tr><td><code>Ctrl</code>-<code>L</code></td><td>Clear screen</td></tr>
<tr><td><code>Up</code>, <code>Down</code></td><td>Browse command history</td></tr>
<tr><td><code>Ctrl</code>-<code>R</code></td><td>Search command history</td></tr>
<tr><td><code>Ctrl</code>-<code>C</code></td><td>Clear the current line</td></tr>
<tr><td><code>Alt</code>-<code>Enter</code></td><td>Insert newline</td></tr>
<tr><td><code>Home</code>, <code>Ctrl</code>-<code>A</code></td><td>Move cursor to the beginning of the line</td></tr>
<tr><td><code>End</code>, <code>Ctrl</code>-<code>E</code></td><td>Move cursor to the end of the line</td></tr>
<tr><td><code>Ctrl</code>-<code>W</code></td><td>Delete word leading up to cursor</td></tr>
</tbody></table>
</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>Usage</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>Modes</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">You can run the Numbat command-line application in three different modes:</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">| Mode | Command to run |</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">| Start an interactive session (REPL) | `numbat` |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">| Run a Numbat program | `numbat script.nbt` |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">| Evaluate a single expression | `numbat -e &#39;30 km/h -&gt; mi/h&#39;` |</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>##</a-p> <a-tt>Command-line options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">See `numbat --help` for more information.</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>##</a-p> <a-tt>Interactive sessions</a-tt></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">Interactive sessions allow you to perform a sequence of calculations. You can use the special identifiers</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">`ans` or `_` to refer to the result of the last calculation. For example:</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-tl> numbat</a-tl></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>&gt;&gt;&gt; 60 kW h / 150 kW</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>    = 0.4 h</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>&gt;&gt;&gt; ans -&gt; minutes</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>    = 24 min</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 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-tt>Commands</a-tt></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>There is a set of special commands that only work in interactive mode:</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"></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>| Command | Action |</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"><a-p>| `list`, `ls` | List all functions, dimensions, variables and units |</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>| `list &lt;what&gt;` | Where `&lt;what&gt;` can be `functions`, `dimensions`, `variables`, `units` |</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>| `info &lt;identifier&gt;` | Get more information about units and variables |</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>| `clear` | Clear screen |</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>| `help`, `?` | View short help text |</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>| `quit`, `exit` | Quit the session |</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>Key bindings</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">In interactive command-line mode, you can use the following key bindings. Most importantly,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">`Tab` for auto-completion, arrow keys and `Ctrl-R` for browsing the command history, and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">`Ctrl-D` for exiting the interactive session.</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">| Key sequence | Action |</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">| `Tab`, `Ctrl`-`I` | Auto-completion |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">| `Ctrl`-`D` | Quit |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">| `Ctrl`-`L` | Clear screen |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">| `Up`, `Down` | Browse command history |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text">| `Ctrl`-`R` | Search command history |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">| `Ctrl`-`C` | Clear the current line |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">| `Alt`-`Enter` | Insert newline |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">| `Home`, `Ctrl`-`A` | Move cursor to the beginning of the line |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">| `End`, `Ctrl`-`E` | Move cursor to the end of the line |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">| `Ctrl`-`W` | Delete word leading up to cursor |</span></span></pre></div></div>
</main>
</body>
</html>
