deploy: 726082ba03

versions/doc-improvements/docs/api/bait/index.html

@@ -16,8 +16,7 @@ Consider this part of it:</p><div class=highlight><pre tabindex=0 style=backgrou
 </span></span><span style=display:flex><span><span style=color:#080;font-weight:700>end</span>)
 </span></span></code></pre></div><p>What this does is, whenever the <code>command.exit</code> event is thrown,
 this function will set the user prompt.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#catch>catch(name, cb)</a></td><td>Catches a hook with <code>name</code>. Runs the <code>cb</code> when it is thrown</td></tr><tr><td><a href=#catchOnce>catchOnce(name, cb)</a></td><td>Same as catch, but only runs the <code>cb</code> once and then removes the hook</td></tr><tr><td><a href=#hooks>hooks(name) -> table</a></td><td>Returns a table with hooks (callback functions) on the event with <code>name</code>.</td></tr><tr><td><a href=#release>release(name, catcher)</a></td><td>Removes the <code>catcher</code> for the event with <code>name</code>.</td></tr><tr><td><a href=#throw>throw(name, &mldr;args)</a></td><td>Throws a hook with <code>name</code> with the provided <code>args</code></td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#catch>catch(name, cb)</a></td><td>Catches a hook with <code>name</code>. Runs the <code>cb</code> when it is thrown</td></tr><tr><td><a href=#catchOnce>catchOnce(name, cb)</a></td><td>Same as catch, but only runs the <code>cb</code> once and then removes the hook</td></tr><tr><td><a href=#hooks>hooks(name) -> table</a></td><td>Returns a table with hooks (callback functions) on the event with <code>name</code>.</td></tr><tr><td><a href=#release>release(name, catcher)</a></td><td>Removes the <code>catcher</code> for the event with <code>name</code>.</td></tr><tr><td><a href=#throw>throw(name, &mldr;args)</a></td><td>Throws a hook with <code>name</code> with the provided <code>args</code></td></tr></tbody></table><hr><div id=catch><h4 class=heading>bait.catch(name, cb)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=catch><h4 class=heading>bait.catch(name, cb)
 <a href=#catch class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Catches a hook with <code>name</code>. Runs the <code>cb</code> when it is thrown</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>ummm</p><p><code>function</code> <strong><code>cb</code></strong><br>?</p></div><hr><div id=catchOnce><h4 class=heading>bait.catchOnce(name, cb)
 <a href=#catchOnce class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Same as catch, but only runs the <code>cb</code> once and then removes the hook</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/commander/index.html

@@ -18,8 +18,7 @@ and <code>err</code>. The values of these is a <a href=/Hilbish/docs/api/hilbish
 to get user input.</li><li><code>out</code> is standard output. This is usually where text meant for
 output should go.</li><li><code>err</code> is standard error. This sink is for writing errors, as the
 name would suggest.</li></ul><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#deregister>deregister(name)</a></td><td>Deregisters any command registered with <code>name</code></td></tr><tr><td><a href=#register>register(name, cb)</a></td><td>Register a command with <code>name</code> that runs <code>cb</code> when ran</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#deregister>deregister(name)</a></td><td>Deregisters any command registered with <code>name</code></td></tr><tr><td><a href=#register>register(name, cb)</a></td><td>Register a command with <code>name</code> that runs <code>cb</code> when ran</td></tr></tbody></table><hr><div id=deregister><h4 class=heading>commander.deregister(name)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=deregister><h4 class=heading>commander.deregister(name)
 <a href=#deregister class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deregisters any command registered with <code>name</code></p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=register><h4 class=heading>commander.register(name, cb)
 <a href=#register class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Register a command with <code>name</code> that runs <code>cb</code> when ran</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/fs/index.html

@@ -5,8 +5,7 @@
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The fs module provides easy and simple access to filesystem functions
 and other things, and acts an addition to the Lua standard library&rsquo;s
 I/O and filesystem functions.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#abs>abs(path) -> string</a></td><td>Gives an absolute version of <code>path</code>.</td></tr><tr><td><a href=#basename>basename(path) -> string</a></td><td>Gives the basename of <code>path</code>. For the rules,</td></tr><tr><td><a href=#cd>cd(dir)</a></td><td>Changes directory to <code>dir</code></td></tr><tr><td><a href=#dir>dir(path) -> string</a></td><td>Returns the directory part of <code>path</code>. For the rules, see Go&rsquo;s</td></tr><tr><td><a href=#glob>glob(pattern) -> matches (table)</a></td><td>Glob all files and directories that match the pattern.</td></tr><tr><td><a href=#join>join(&mldr;) -> string</a></td><td>Takes paths and joins them together with the OS&rsquo;s</td></tr><tr><td><a href=#mkdir>mkdir(name, recursive)</a></td><td>Makes a directory called <code>name</code>. If <code>recursive</code> is true, it will create its parent directories.</td></tr><tr><td><a href=#readdir>readdir(dir) -> {}</a></td><td>Returns a table of files in <code>dir</code>.</td></tr><tr><td><a href=#stat>stat(path) -> {}</a></td><td>Returns a table of info about the <code>path</code>.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#abs>abs(path) -> string</a></td><td>Gives an absolute version of <code>path</code>.</td></tr><tr><td><a href=#basename>basename(path) -> string</a></td><td>Gives the basename of <code>path</code>. For the rules,</td></tr><tr><td><a href=#cd>cd(dir)</a></td><td>Changes directory to <code>dir</code></td></tr><tr><td><a href=#dir>dir(path) -> string</a></td><td>Returns the directory part of <code>path</code>. For the rules, see Go&rsquo;s</td></tr><tr><td><a href=#glob>glob(pattern) -> matches (table)</a></td><td>Glob all files and directories that match the pattern.</td></tr><tr><td><a href=#join>join(&mldr;) -> string</a></td><td>Takes paths and joins them together with the OS&rsquo;s</td></tr><tr><td><a href=#mkdir>mkdir(name, recursive)</a></td><td>Makes a directory called <code>name</code>. If <code>recursive</code> is true, it will create its parent directories.</td></tr><tr><td><a href=#readdir>readdir(dir) -> {}</a></td><td>Returns a table of files in <code>dir</code>.</td></tr><tr><td><a href=#stat>stat(path) -> {}</a></td><td>Returns a table of info about the <code>path</code>.</td></tr></tbody></table><hr><div id=abs><h4 class=heading>fs.abs(path) -> string
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=abs><h4 class=heading>fs.abs(path) -> string
 <a href=#abs class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Gives an absolute version of <code>path</code>.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=basename><h4 class=heading>fs.basename(path) -> string
 <a href=#basename class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Gives the basename of <code>path</code>. For the rules,

versions/doc-improvements/docs/api/hilbish/hilbish.aliases/index.html

@@ -3,8 +3,7 @@
 <button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
 <span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/ class=nav-link>Module hilbish.completions</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/ class=nav-link>Module hilbish.editor</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/ class=nav-link>Module hilbish.history</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/ class=nav-link>Module hilbish.jobs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/ class=nav-link>Module hilbish.os</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/ class=nav-link>Module hilbish.timers</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.aliases</h1><p><em>command aliasing<br></em></p><h3 id=introduction class=heading>Introduction
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The alias interface deals with all command aliases in Hilbish.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#aliases.add>add(alias, cmd)</a></td><td>This is an alias (ha) for the <code>hilbish.alias</code> function.</td></tr><tr><td><a href=#aliases.delete>delete(name)</a></td><td>Removes an alias.</td></tr><tr><td><a href=#aliases.list>list() -> table&lt;string, string></a></td><td>Get a table of all aliases, with string keys as the alias and the value as the command.</td></tr><tr><td><a href=#aliases.resolve>resolve(alias) -> command (string)</a></td><td>Tries to resolve an alias to its command.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#aliases.add>add(alias, cmd)</a></td><td>This is an alias (ha) for the <code>hilbish.alias</code> function.</td></tr><tr><td><a href=#aliases.delete>delete(name)</a></td><td>Removes an alias.</td></tr><tr><td><a href=#aliases.list>list() -> table&lt;string, string></a></td><td>Get a table of all aliases, with string keys as the alias and the value as the command.</td></tr><tr><td><a href=#aliases.resolve>resolve(alias) -> command (string)</a></td><td>Tries to resolve an alias to its command.</td></tr></tbody></table><hr><div id=aliases.add><h4 class=heading>hilbish.aliases.add(alias, cmd)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=aliases.add><h4 class=heading>hilbish.aliases.add(alias, cmd)
 <a href=#aliases.add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>This is an alias (ha) for the <code>hilbish.alias</code> function.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=aliases.delete><h4 class=heading>hilbish.aliases.delete(name)
 <a href=#aliases.delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Removes an alias.</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/hilbish/hilbish.completions/index.html

@@ -3,8 +3,7 @@
 <button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
 <span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/ class=nav-link>Module hilbish.completions</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/ class=nav-link>Module hilbish.editor</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/ class=nav-link>Module hilbish.history</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/ class=nav-link>Module hilbish.jobs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/ class=nav-link>Module hilbish.os</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/ class=nav-link>Module hilbish.timers</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.completions</h1><p><em>tab completions<br></em></p><h3 id=introduction class=heading>Introduction
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The completions interface deals with tab completions.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#completions.call>call(name, query, ctx, fields) -> completionGroups (table), prefix (string)</a></td><td>Calls a completer function. This is mainly used to call</td></tr><tr><td><a href=#completions.handler>handler(line, pos)</a></td><td>The handler function is the callback for tab completion in Hilbish.</td></tr><tr><td><a href=#completions.bins>bins(query, ctx, fields) -> entries (table), prefix (string)</a></td><td>Returns binary/executale completion candidates based on the provided query.</td></tr><tr><td><a href=#completions.files>files(query, ctx, fields) -> entries (table), prefix (string)</a></td><td>Returns file completion candidates based on the provided query.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#completions.call>call(name, query, ctx, fields) -> completionGroups (table), prefix (string)</a></td><td>Calls a completer function. This is mainly used to call</td></tr><tr><td><a href=#completions.handler>handler(line, pos)</a></td><td>The handler function is the callback for tab completion in Hilbish.</td></tr><tr><td><a href=#completions.bins>bins(query, ctx, fields) -> entries (table), prefix (string)</a></td><td>Returns binary/executale completion candidates based on the provided query.</td></tr><tr><td><a href=#completions.files>files(query, ctx, fields) -> entries (table), prefix (string)</a></td><td>Returns file completion candidates based on the provided query.</td></tr></tbody></table><hr><div id=completions.call><h4 class=heading>hilbish.completions.call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=completions.call><h4 class=heading>hilbish.completions.call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
 <a href=#completions.call class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Calls a completer function. This is mainly used to call
 a command completer, which will have a <code>name</code> in the form
 of <code>command.name</code>, example: <code>command.git</code>.

versions/doc-improvements/docs/api/hilbish/hilbish.editor/index.html

@@ -4,8 +4,7 @@
 <span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/ class=nav-link>Module hilbish.completions</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/ class=nav-link>Module hilbish.editor</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/ class=nav-link>Module hilbish.history</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/ class=nav-link>Module hilbish.jobs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/ class=nav-link>Module hilbish.os</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/ class=nav-link>Module hilbish.timers</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.editor</h1><p><em>interactions for Hilbish's line reader<br></em></p><h3 id=introduction class=heading>Introduction
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The hilbish.editor interface provides functions to
 directly interact with the line editor in use.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#editor.getLine>getLine() -> string</a></td><td>Returns the current input line.</td></tr><tr><td><a href=#editor.getVimRegister>getVimRegister(register) -> string</a></td><td>Returns the text that is at the register.</td></tr><tr><td><a href=#editor.insert>insert(text)</a></td><td>Inserts text into the line.</td></tr><tr><td><a href=#editor.setVimRegister>setVimRegister(register, text)</a></td><td>Sets the vim register at <code>register</code> to hold the passed text.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#editor.getLine>getLine() -> string</a></td><td>Returns the current input line.</td></tr><tr><td><a href=#editor.getVimRegister>getVimRegister(register) -> string</a></td><td>Returns the text that is at the register.</td></tr><tr><td><a href=#editor.insert>insert(text)</a></td><td>Inserts text into the line.</td></tr><tr><td><a href=#editor.setVimRegister>setVimRegister(register, text)</a></td><td>Sets the vim register at <code>register</code> to hold the passed text.</td></tr></tbody></table><hr><div id=editor.getLine><h4 class=heading>hilbish.editor.getLine() -> string
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=editor.getLine><h4 class=heading>hilbish.editor.getLine() -> string
 <a href=#editor.getLine class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the current input line.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=editor.getVimRegister><h4 class=heading>hilbish.editor.getVimRegister(register) -> string
 <a href=#editor.getVimRegister class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the text that is at the register.</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/hilbish/hilbish.history/index.html

@@ -5,8 +5,7 @@
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The history interface deals with command history.
 This includes the ability to override functions to change the main
 method of saving history.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#history.add>add(cmd)</a></td><td>Adds a command to the history.</td></tr><tr><td><a href=#history.all>all() -> table</a></td><td>Retrieves all history.</td></tr><tr><td><a href=#history.clear>clear()</a></td><td>Deletes all commands from the history.</td></tr><tr><td><a href=#history.get>get(idx)</a></td><td>Retrieves a command from the history based on the <code>idx</code>.</td></tr><tr><td><a href=#history.size>size() -> number</a></td><td>Returns the amount of commands in the history.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#history.add>add(cmd)</a></td><td>Adds a command to the history.</td></tr><tr><td><a href=#history.all>all() -> table</a></td><td>Retrieves all history.</td></tr><tr><td><a href=#history.clear>clear()</a></td><td>Deletes all commands from the history.</td></tr><tr><td><a href=#history.get>get(idx)</a></td><td>Retrieves a command from the history based on the <code>idx</code>.</td></tr><tr><td><a href=#history.size>size() -> number</a></td><td>Returns the amount of commands in the history.</td></tr></tbody></table><hr><div id=history.add><h4 class=heading>hilbish.history.add(cmd)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=history.add><h4 class=heading>hilbish.history.add(cmd)
 <a href=#history.add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Adds a command to the history.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=history.all><h4 class=heading>hilbish.history.all() -> table
 <a href=#history.all class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Retrieves all history.</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/hilbish/hilbish.jobs/index.html

@@ -4,8 +4,7 @@
 <span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/ class=nav-link>Module hilbish.completions</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/ class=nav-link>Module hilbish.editor</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/ class=nav-link>Module hilbish.history</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/ class=nav-link>Module hilbish.jobs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/ class=nav-link>Module hilbish.os</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/ class=nav-link>Module hilbish.timers</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.jobs</h1><p><em>background job management<br></em></p><h3 id=introduction class=heading>Introduction
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Manage interactive jobs in Hilbish via Lua.</p><p>Jobs are the name of background tasks/commands. A job can be started via
 interactive usage or with the functions defined below for use in external runners.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#jobs.add>add(cmdstr, args, execPath)</a></td><td>Adds a new job to the job table. Note that this does not immediately run it.</td></tr><tr><td><a href=#jobs.all>all() -> table&lt;@Job></a></td><td>Returns a table of all job objects.</td></tr><tr><td><a href=#jobs.disown>disown(id)</a></td><td>Disowns a job. This deletes it from the job table.</td></tr><tr><td><a href=#jobs.get>get(id) -> @Job</a></td><td>Get a job object via its ID.</td></tr><tr><td><a href=#jobs.last>last() -> @Job</a></td><td>Returns the last added job from the table.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#jobs.add>add(cmdstr, args, execPath)</a></td><td>Adds a new job to the job table. Note that this does not immediately run it.</td></tr><tr><td><a href=#jobs.all>all() -> table&lt;@Job></a></td><td>Returns a table of all job objects.</td></tr><tr><td><a href=#jobs.disown>disown(id)</a></td><td>Disowns a job. This deletes it from the job table.</td></tr><tr><td><a href=#jobs.get>get(id) -> @Job</a></td><td>Get a job object via its ID.</td></tr><tr><td><a href=#jobs.last>last() -> @Job</a></td><td>Returns the last added job from the table.</td></tr></tbody></table><hr><div id=jobs.add><h4 class=heading>hilbish.jobs.add(cmdstr, args, execPath)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=jobs.add><h4 class=heading>hilbish.jobs.add(cmdstr, args, execPath)
 <a href=#jobs.add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Adds a new job to the job table. Note that this does not immediately run it.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=jobs.all><h4 class=heading>hilbish.jobs.all() -> table\<<a href=/Hilbish/docs/api/hilbish/hilbish.jobs/#job style=text-decoration:none id=lol>Job</a>>
 <a href=#jobs.all class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns a table of all job objects.</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/hilbish/hilbish.runner/index.html

@@ -7,8 +7,7 @@ how Hilbish interprets interactive input.
 Users can add and change the default runner for interactive input to any
 language or script of their choosing. A good example is using it to
 write command in Fennel.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#runner.setMode>setMode(cb)</a></td><td>This is the same as the <code>hilbish.runnerMode</code> function. It takes a callback,</td></tr><tr><td><a href=#runner.lua>lua(cmd)</a></td><td>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code></td></tr><tr><td><a href=#runner.sh>sh(cmd)</a></td><td>Runs a command in Hilbish&rsquo;s shell script interpreter.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#runner.setMode>setMode(cb)</a></td><td>This is the same as the <code>hilbish.runnerMode</code> function. It takes a callback,</td></tr><tr><td><a href=#runner.lua>lua(cmd)</a></td><td>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code></td></tr><tr><td><a href=#runner.sh>sh(cmd)</a></td><td>Runs a command in Hilbish&rsquo;s shell script interpreter.</td></tr></tbody></table><hr><div id=runner.setMode><h4 class=heading>hilbish.runner.setMode(cb)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=runner.setMode><h4 class=heading>hilbish.runner.setMode(cb)
 <a href=#runner.setMode class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>This is the same as the <code>hilbish.runnerMode</code> function. It takes a callback,
 which will be used to execute all interactive input.
 In normal cases, neither callbacks should be overrided by the user,

versions/doc-improvements/docs/api/hilbish/hilbish.timers/index.html

@@ -15,8 +15,7 @@ t:start()
 print(t.running) // true
 </code></pre><h3 id=functions class=heading>Functions
 <a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#timers.create>create(type, time, callback) -> @Timer</a></td><td>Creates a timer that runs based on the specified <code>time</code> in milliseconds.</td></tr><tr><td><a href=#timers.get>get(id) -> @Timer</a></td><td>Retrieves a timer via its ID.</td></tr></tbody></table><h3 id=static-module-fields class=heading>Static module fields
-<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>INTERVAL</td><td>Constant for an interval timer type</td></tr><tr><td>TIMEOUT</td><td>Constant for a timeout timer type</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>INTERVAL</td><td>Constant for an interval timer type</td></tr><tr><td>TIMEOUT</td><td>Constant for a timeout timer type</td></tr></tbody></table><hr><div id=timers.create><h4 class=heading>hilbish.timers.create(type, time, callback) -> <a href=/Hilbish/docs/api/hilbish/hilbish.timers/#timer style=text-decoration:none id=lol>Timer</a>
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=timers.create><h4 class=heading>hilbish.timers.create(type, time, callback) -> <a href=/Hilbish/docs/api/hilbish/hilbish.timers/#timer style=text-decoration:none id=lol>Timer</a>
 <a href=#timers.create class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Creates a timer that runs based on the specified <code>time</code> in milliseconds.
 The <code>type</code> can either be <code>hilbish.timers.INTERVAL</code> or <code>hilbish.timers.TIMEOUT</code></p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=timers.get><h4 class=heading>hilbish.timers.get(id) -> <a href=/Hilbish/docs/api/hilbish/hilbish.timers/#timer style=text-decoration:none id=lol>Timer</a>

versions/doc-improvements/docs/api/hilbish/index.html

@@ -5,8 +5,7 @@
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The Hilbish module includes the core API, containing
 interfaces and functions which directly relate to shell functionality.</p><h3 id=functions class=heading>Functions
 <a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#alias>alias(cmd, orig)</a></td><td>Sets an alias of <code>cmd</code> to <code>orig</code></td></tr><tr><td><a href=#appendPath>appendPath(dir)</a></td><td>Appends <code>dir</code> to $PATH</td></tr><tr><td><a href=#complete>complete(scope, cb)</a></td><td>Registers a completion handler for <code>scope</code>.</td></tr><tr><td><a href=#cwd>cwd() -> string</a></td><td>Returns the current directory of the shell</td></tr><tr><td><a href=#exec>exec(cmd)</a></td><td>Replaces running hilbish with <code>cmd</code></td></tr><tr><td><a href=#goro>goro(fn)</a></td><td>Puts <code>fn</code> in a goroutine</td></tr><tr><td><a href=#highlighter>highlighter(line)</a></td><td>Line highlighter handler. This is mainly for syntax highlighting, but in</td></tr><tr><td><a href=#hinter>hinter(line, pos)</a></td><td>The command line hint handler. It gets called on every key insert to</td></tr><tr><td><a href=#inputMode>inputMode(mode)</a></td><td>Sets the input mode for Hilbish&rsquo;s line reader. Accepts either emacs or vim</td></tr><tr><td><a href=#interval>interval(cb, time) -> @Timer</a></td><td>Runs the <code>cb</code> function every <code>time</code> milliseconds.</td></tr><tr><td><a href=#multiprompt>multiprompt(str)</a></td><td>Changes the continued line prompt to <code>str</code></td></tr><tr><td><a href=#prependPath>prependPath(dir)</a></td><td>Prepends <code>dir</code> to $PATH</td></tr><tr><td><a href=#prompt>prompt(str, typ)</a></td><td>Changes the shell prompt to <code>str</code></td></tr><tr><td><a href=#read>read(prompt) -> input (string)</a></td><td>Read input from the user, using Hilbish&rsquo;s line editor/input reader.</td></tr><tr><td><a href=#run>run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)</a></td><td>Runs <code>cmd</code> in Hilbish&rsquo;s sh interpreter.</td></tr><tr><td><a href=#runnerMode>runnerMode(mode)</a></td><td>Sets the execution/runner mode for interactive Hilbish. This determines whether</td></tr><tr><td><a href=#timeout>timeout(cb, time) -> @Timer</a></td><td>Runs the <code>cb</code> function after <code>time</code> in milliseconds.</td></tr><tr><td><a href=#which>which(name) -> string</a></td><td>Checks if <code>name</code> is a valid command.</td></tr></tbody></table><h3 id=static-module-fields class=heading>Static module fields
-<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>ver</td><td>The version of Hilbish</td></tr><tr><td>goVersion</td><td>The version of Go that Hilbish was compiled with</td></tr><tr><td>user</td><td>Username of the user</td></tr><tr><td>host</td><td>Hostname of the machine</td></tr><tr><td>dataDir</td><td>Directory for Hilbish data files, including the docs and default modules</td></tr><tr><td>interactive</td><td>Is Hilbish in an interactive shell?</td></tr><tr><td>login</td><td>Is Hilbish the login shell?</td></tr><tr><td>vimMode</td><td>Current Vim input mode of Hilbish (will be nil if not in Vim input mode)</td></tr><tr><td>exitCode</td><td>xit code of the last executed command</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>ver</td><td>The version of Hilbish</td></tr><tr><td>goVersion</td><td>The version of Go that Hilbish was compiled with</td></tr><tr><td>user</td><td>Username of the user</td></tr><tr><td>host</td><td>Hostname of the machine</td></tr><tr><td>dataDir</td><td>Directory for Hilbish data files, including the docs and default modules</td></tr><tr><td>interactive</td><td>Is Hilbish in an interactive shell?</td></tr><tr><td>login</td><td>Is Hilbish the login shell?</td></tr><tr><td>vimMode</td><td>Current Vim input mode of Hilbish (will be nil if not in Vim input mode)</td></tr><tr><td>exitCode</td><td>xit code of the last executed command</td></tr></tbody></table><hr><div id=alias><h4 class=heading>hilbish.alias(cmd, orig)
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=alias><h4 class=heading>hilbish.alias(cmd, orig)
 <a href=#alias class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets an alias of <code>cmd</code> to <code>orig</code></p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=appendPath><h4 class=heading>hilbish.appendPath(dir)
 <a href=#appendPath class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Appends <code>dir</code> to $PATH</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/hilbish/index.xml

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Module hilbish on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/</link><description>Recent content in Module hilbish on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/index.xml" rel="self" type="application/rss+xml"/><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/</guid><description>Introduction The alias interface deals with all command aliases in Hilbish.
-Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&amp;gt; table&amp;lt;string, string&amp;gt; Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; command (string) Tries to resolve an alias to its command. Functions hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</guid><description>Introduction The completions interface deals with tab completions.
+Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&amp;gt; table&amp;lt;string, string&amp;gt; Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; command (string) Tries to resolve an alias to its command. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</guid><description>Introduction The completions interface deals with tab completions.
 Functions call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call handler(line, pos) The handler function is the callback for tab completion in Hilbish. bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns binary/executale completion candidates based on the provided query. files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file completion candidates based on the provided query.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
-Functions getLine() -&amp;gt; string Returns the current input line. getVimRegister(register) -&amp;gt; string Returns the text that is at the register. insert(text) Inserts text into the line. setVimRegister(register, text) Sets the vim register at register to hold the passed text. Functions hilbish.editor.getLine() -> string Returns the current input line.
+Functions getLine() -&amp;gt; string Returns the current input line. getVimRegister(register) -&amp;gt; string Returns the text that is at the register. insert(text) Inserts text into the line. setVimRegister(register, text) Sets the vim register at register to hold the passed text. hilbish.editor.getLine() -> string Returns the current input line.
-Parameters This function has no parameters.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
+Parameters This function has no parameters.
-Functions add(cmd) Adds a command to the history. all() -&amp;gt; table Retrieves all history. clear() Deletes all commands from the history. get(idx) Retrieves a command from the history based on the idx. size() -&amp;gt; number Returns the amount of commands in the history. Functions hilbish.history.add(cmd) Adds a command to the history.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
+hilbish.editor.getVimRegister(register) -> string Returns the text that is at the register.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
+Functions add(cmd) Adds a command to the history. all() -&amp;gt; table Retrieves all history. clear() Deletes all commands from the history. get(idx) Retrieves a command from the history based on the idx. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.history.add(cmd) Adds a command to the history.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
 Jobs are the name of background tasks/commands. A job can be started via interactive usage or with the functions defined below for use in external runners.
 Functions add(cmdstr, args, execPath) Adds a new job to the job table. Note that this does not immediately run it. all() -&amp;gt; table&amp;lt;@Job&amp;gt; Returns a table of all job objects. disown(id) Disowns a job. This deletes it from the job table.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/</guid><description> Introduction The os interface provides simple text information properties about the current OS on the systen. This mainly includes the name and version.
 Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.

versions/doc-improvements/docs/api/index.xml

@@ -2,5 +2,5 @@
 Usage of the Bait module consists of userstanding event-driven architecture, but it&amp;rsquo;s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.</description></item><item><title>Module commander</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/commander/</guid><description>Introduction Commander is a library for writing custom commands in Lua. In order to make it easier to write commands for Hilbish, not require separate scripts and to be able to use in a config, the Commander library exists. This is like a very simple wrapper that works with Hilbish for writing commands. Example:
 local commander = require &amp;#39;commander&amp;#39; commander.register(&amp;#39;hello&amp;#39;, function(args, sinks) sinks.out:writeln &amp;#39;Hello world!&amp;#39; end) In this example, a command with the name of hello is created that will print Hello world!</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/fs/</guid><description>Introduction The fs module provides easy and simple access to filesystem functions and other things, and acts an addition to the Lua standard library&amp;rsquo;s I/O and filesystem functions.
 Functions abs(path) -&amp;gt; string Gives an absolute version of path. basename(path) -&amp;gt; string Gives the basename of path. For the rules, cd(dir) Changes directory to dir dir(path) -&amp;gt; string Returns the directory part of path. For the rules, see Go&amp;rsquo;s glob(pattern) -&amp;gt; matches (table) Glob all files and directories that match the pattern.</description></item><item><title>Module terminal</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/terminal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/terminal/</guid><description>Introduction The terminal library is a simple and lower level library for certain terminal interactions.
-Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal setRaw() Puts the terminal in raw mode size() Gets the dimensions of the terminal. Returns a table with width and height Functions terminal.restoreState() Restores the last saved state of the terminal
+Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal setRaw() Puts the terminal in raw mode size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal
 Parameters This function has no parameters.</description></item></channel></rss>

versions/doc-improvements/docs/api/terminal/index.html

@@ -3,8 +3,7 @@
 <button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
 <span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/ class=nav-link>Module hilbish.completions</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/ class=nav-link>Module hilbish.editor</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/ class=nav-link>Module hilbish.history</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/ class=nav-link>Module hilbish.jobs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/ class=nav-link>Module hilbish.os</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/ class=nav-link>Module hilbish.timers</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module terminal</h1><p><em>low level terminal library<br></em></p><h3 id=introduction class=heading>Introduction
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The terminal library is a simple and lower level library for certain terminal interactions.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#restoreState>restoreState()</a></td><td>Restores the last saved state of the terminal</td></tr><tr><td><a href=#saveState>saveState()</a></td><td>Saves the current state of the terminal</td></tr><tr><td><a href=#setRaw>setRaw()</a></td><td>Puts the terminal in raw mode</td></tr><tr><td><a href=#size>size()</a></td><td>Gets the dimensions of the terminal. Returns a table with <code>width</code> and <code>height</code></td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#restoreState>restoreState()</a></td><td>Restores the last saved state of the terminal</td></tr><tr><td><a href=#saveState>saveState()</a></td><td>Saves the current state of the terminal</td></tr><tr><td><a href=#setRaw>setRaw()</a></td><td>Puts the terminal in raw mode</td></tr><tr><td><a href=#size>size()</a></td><td>Gets the dimensions of the terminal. Returns a table with <code>width</code> and <code>height</code></td></tr></tbody></table><hr><div id=restoreState><h4 class=heading>terminal.restoreState()
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=restoreState><h4 class=heading>terminal.restoreState()
 <a href=#restoreState class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Restores the last saved state of the terminal</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=saveState><h4 class=heading>terminal.saveState()
 <a href=#saveState class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Saves the current state of the terminal</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/index.xml

@@ -18,18 +18,19 @@ For the latest stable release, check here: https://github.com/Rosettea/Hilbish/r
 Usage of the Bait module consists of userstanding event-driven architecture, but it&amp;rsquo;s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.</description></item><item><title>Module commander</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/commander/</guid><description>Introduction Commander is a library for writing custom commands in Lua. In order to make it easier to write commands for Hilbish, not require separate scripts and to be able to use in a config, the Commander library exists. This is like a very simple wrapper that works with Hilbish for writing commands. Example:
 local commander = require &amp;#39;commander&amp;#39; commander.register(&amp;#39;hello&amp;#39;, function(args, sinks) sinks.out:writeln &amp;#39;Hello world!&amp;#39; end) In this example, a command with the name of hello is created that will print Hello world!</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/fs/</guid><description>Introduction The fs module provides easy and simple access to filesystem functions and other things, and acts an addition to the Lua standard library&amp;rsquo;s I/O and filesystem functions.
 Functions abs(path) -&amp;gt; string Gives an absolute version of path. basename(path) -&amp;gt; string Gives the basename of path. For the rules, cd(dir) Changes directory to dir dir(path) -&amp;gt; string Returns the directory part of path. For the rules, see Go&amp;rsquo;s glob(pattern) -&amp;gt; matches (table) Glob all files and directories that match the pattern.</description></item><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/</guid><description>Introduction The alias interface deals with all command aliases in Hilbish.
-Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&amp;gt; table&amp;lt;string, string&amp;gt; Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; command (string) Tries to resolve an alias to its command. Functions hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</guid><description>Introduction The completions interface deals with tab completions.
+Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&amp;gt; table&amp;lt;string, string&amp;gt; Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; command (string) Tries to resolve an alias to its command. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</guid><description>Introduction The completions interface deals with tab completions.
 Functions call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call handler(line, pos) The handler function is the callback for tab completion in Hilbish. bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns binary/executale completion candidates based on the provided query. files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file completion candidates based on the provided query.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
-Functions getLine() -&amp;gt; string Returns the current input line. getVimRegister(register) -&amp;gt; string Returns the text that is at the register. insert(text) Inserts text into the line. setVimRegister(register, text) Sets the vim register at register to hold the passed text. Functions hilbish.editor.getLine() -> string Returns the current input line.
+Functions getLine() -&amp;gt; string Returns the current input line. getVimRegister(register) -&amp;gt; string Returns the text that is at the register. insert(text) Inserts text into the line. setVimRegister(register, text) Sets the vim register at register to hold the passed text. hilbish.editor.getLine() -> string Returns the current input line.
-Parameters This function has no parameters.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
+Parameters This function has no parameters.
-Functions add(cmd) Adds a command to the history. all() -&amp;gt; table Retrieves all history. clear() Deletes all commands from the history. get(idx) Retrieves a command from the history based on the idx. size() -&amp;gt; number Returns the amount of commands in the history. Functions hilbish.history.add(cmd) Adds a command to the history.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
+hilbish.editor.getVimRegister(register) -> string Returns the text that is at the register.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
+Functions add(cmd) Adds a command to the history. all() -&amp;gt; table Retrieves all history. clear() Deletes all commands from the history. get(idx) Retrieves a command from the history based on the idx. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.history.add(cmd) Adds a command to the history.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
 Jobs are the name of background tasks/commands. A job can be started via interactive usage or with the functions defined below for use in external runners.
 Functions add(cmdstr, args, execPath) Adds a new job to the job table. Note that this does not immediately run it. all() -&amp;gt; table&amp;lt;@Job&amp;gt; Returns a table of all job objects. disown(id) Disowns a job. This deletes it from the job table.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/</guid><description> Introduction The os interface provides simple text information properties about the current OS on the systen. This mainly includes the name and version.
 Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
 Functions setMode(cb) This is the same as the hilbish.runnerMode function. It takes a callback, lua(cmd) Evaluates cmd as Lua input. This is the same as using dofile sh(cmd) Runs a command in Hilbish&amp;rsquo;s shell script interpreter.</description></item><item><title>Module hilbish.timers</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/</guid><description>Introduction If you ever want to run a piece of code on a timed interval, or want to wait a few seconds, you don&amp;rsquo;t have to rely on timing tricks, as Hilbish has a timer API to set intervals and timeouts.
 These are the simple functions hilbish.interval and hilbish.timeout (doc accessible with doc hilbish). But if you want slightly more control over them, there is the hilbish.timers interface. It allows you to get a timer via ID and control them.</description></item><item><title>Module hilbish.userDir</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/</guid><description> Introduction This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user&amp;rsquo;s preferred directories for configs and data.
 Static module fields config The user&amp;rsquo;s config directory data The user&amp;rsquo;s directory for program data</description></item><item><title>Module terminal</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/terminal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/terminal/</guid><description>Introduction The terminal library is a simple and lower level library for certain terminal interactions.
-Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal setRaw() Puts the terminal in raw mode size() Gets the dimensions of the terminal. Returns a table with width and height Functions terminal.restoreState() Restores the last saved state of the terminal
+Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal setRaw() Puts the terminal in raw mode size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal
 Parameters This function has no parameters.</description></item><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface.
 A message is defined as a table with the following properties:
 icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.</description></item><item><title>Runner Mode</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.