<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/cli-customization.md - fork/numbat @ v1.6.2</title>
<meta name="description" content="book/src/cli-customization.md in fork/numbat at v1.6.2.">
<meta property="og:title" content="book/src/cli-customization.md - fork/numbat @ v1.6.2">
<meta property="og:description" content="book/src/cli-customization.md in fork/numbat at v1.6.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="v1.6.2" data-tip="4926554e3eb378f166658e24a2be99c5403eca59">
<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="ac5a051a81e958776c9ad6a12ece551d5182d91c">Move the module folder</span><span class="snapshot-sha sha" data-commit="ac5a051a81e958776c9ad6a12ece551d5182d91c">ac5a051</span><time datetime="2023-09-21T21:50:56+02:00" title="2023-09-21 21:50:56 +0200">2023-09-21</time></p>
<header class="topbar"><details class="switcher"><summary>v1.6.2</summary><div class="menu"><strong>branches</strong><a 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 class="current" 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.2/tree/book/">book</a> / <a href="/fork/numbat/ref/v1.6.2/tree/book/src/">src</a> / <span class="cur">cli-customization.md</span></nav>
<span class="view-stats"><span>2.1 KiB</span><span>60 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/2e61d9f9444feca9f9b6861b6ea395fd418c3cb1/book/src/cli-customization.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>Customization</h1>
<h2>Startup</h2>
<p>By default, Numbat will load the following modules/files during startup, in order:</p>
<ul>
<li>Numbat Prelude (a module called <code>prelude</code>, either from <code>&lt;module-path&gt;/prelude.nbt</code> if available, or the builtin version)</li>
<li>The user initialization file, if available (a file called <code>init.nbt</code> from <code>&lt;config-path&gt;/init.nbt</code>)</li>
</ul>
<h3>Config path</h3>
<p>Numbat's configuration folder (<code>&lt;config-path&gt;</code> above) can be found under:</p>
<table><thead><tr><th>Platform</th><th>Path</th></tr></thead><tbody>
<tr><td>Linux</td><td><code>$HOME/.config/numbat</code> or <code>$XDG_CONFIG_HOME/numbat</code></td></tr>
<tr><td>macOS</td><td><code>$HOME/Library/Application Support/numbat</code></td></tr>
<tr><td>Windows</td><td><code>C:\Users\Alice\AppData\Roaming\numbat</code></td></tr>
</tbody></table>
<h2>Module paths</h2>
<p>Numbat will load modules from the following sources.
Entries higher up in the list take precedence.</p>
<ul>
<li><code>$NUMBAT_MODULES_PATH</code> — If present, this environment variable can point to a single directory or contain a <code>:</code>-separated list of paths</li>
<li><code>&lt;config-path&gt;/modules</code> — User-customized module folder</li>
<li><code>/usr/share/numbat/modules</code> — System-wide module folder (Linux and macOS)</li>
<li><code>C:\Program Files\numbat\modules</code> — System-wide module folder (Windows)</li>
<li>Builtin modules inside the <code>numbat</code> binary</li>
</ul>
<h2>Customization</h2>
<h3>Custom functions, constants, units</h3>
<p>If you want to add custom functions, constants, or units to your default environment,
create a <code>init.nbt</code> file in your config folder (e.g. <code>~/.config/numbat/init.nbt</code> on Linux).</p>
<h3>Custom modules</h3>
<p>You can also create your own modules that can be loaded on demand. To this end,
create a new file, say <code>&lt;module-path&gt;/user/finance.nbt</code> in one of the module folders
(e.g. <code>~/.config/numbat/modules/custom/finance.nbt</code> on Linux). This module can then be
loaded using</p>
<pre>use custom::finance
</pre>
<p>in your Numbat scripts or in the REPL. You can also load custom modules from <code>init.nbt</code>
if you want to have them available all the time.</p>
<p>You can also organize modules into subfolders (e.g. <code>&lt;module-path&gt;/custom/finance/functions.nbt</code>).
In that case, you can load them using</p>
<pre>use custom::finance::functions
</pre>
<p>In fact, the <code>custom</code> folder is just a convention to avoid name clashes with the
<a href="https://github.com/sharkdp/numbat/tree/master/numbat/modules">standard library</a>.</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>Customization</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>Startup</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">By default, Numbat will load the following modules/files during startup, in order:</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>Numbat Prelude (a module called `prelude`, either from `&lt;module-path&gt;/prelude.nbt` if available, or the builtin version)</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>The user initialization file, if available (a file called `init.nbt` from `&lt;config-path&gt;/init.nbt`)</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-tt>Config path</a-tt></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>Numbat&#39;s configuration folder (`&lt;config-path&gt;` above) can be found under:</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>|Platform|Path|</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"><a-p>|Linux|`$HOME/.config/numbat` or `$XDG_CONFIG_HOME/numbat`|</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>|macOS|`$HOME/Library/Application Support/numbat`|</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>|Windows|`C:\Users\Alice\AppData\Roaming\numbat`|</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-tt>Module paths</a-tt></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>Numbat will load modules from the following sources.</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>Entries higher up in the list take precedence.</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>* `$NUMBAT_MODULES_PATH` — If present, this environment variable can point to a single directory or contain a `:`-separated list of paths</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>* `&lt;config-path&gt;/modules` — User-customized module folder</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>* `/usr/share/numbat/modules` — System-wide module folder (Linux and macOS)</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>* `C:\Program Files\numbat\modules` — System-wide module folder (Windows)</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>* Builtin modules inside the `numbat` binary</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"></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><a-tt>Customization</a-tt></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>### </a-p><a-tt>Custom functions, constants, units</a-tt></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>If you want to add custom functions, constants, or units to your default environment,</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>create a `init.nbt` file in your config folder (e.g. `~/.config/numbat/init.nbt` on Linux).</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"></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>### </a-p><a-tt>Custom modules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></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>You can also create your own modules that can be loaded on demand. To this end,</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>create a new file, say `&lt;module-path&gt;/user/finance.nbt` in one of the module folders</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>(e.g. `~/.config/numbat/modules/custom/finance.nbt` on Linux). This module can then be</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>loaded 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> numbat</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>use custom::finance</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>in your Numbat scripts or in the REPL. You can also load custom modules from `init.nbt`</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"><a-p>if you want to have them available all the time.</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"></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>You can also organize modules into subfolders (e.g. `&lt;module-path&gt;/custom/finance/functions.nbt`).</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>In that case, you can load them using</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> numbat</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>use custom::finance::functions</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">In fact, the `custom` folder is just a convention to avoid name clashes with the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">[standard library](https://github.com/sharkdp/numbat/tree/master/numbat/modules).</span></span></pre></div></div>
</main>
</body>
</html>
