deploy: c71ed0015ffcf4b3746634d1d1ca4cd8ed488d24

versions/readline-move/docs/api/hilbish/index.xml

@@ -1,7 +1,6 @@
 <?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/readline-move/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/readline-move/docs/api/hilbish/index.xml" rel="self" type="application/rss+xml"/><item><title>Module hilbish.abbr</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/</guid><description>Introduction The abbr module manages Hilbish abbreviations. These are words that can be replaced with longer command line strings when entered. As an example, git push can be abbreviated to gp. When the user types gp into the command line, after hitting space or enter, it will expand to git push. Abbreviations can be used as an alternative to aliases. They are saved entirely in the history Instead of the aliased form of the same command.</description></item><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&amp;rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
-Functions bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
+Functions bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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 deleteByAmount(amount) Deletes characters in the line by the given amount. 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 Hilbish command line. getChar() -&amp;gt; string Reads a keystroke from the user. This is in a format of something like Ctrl-L.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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 as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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) Creates a new job. This function does not run the job. This function is intended to be all() -&amp;gt; table[@Job] Returns a table of all job objects. disown(id) Disowns a job. This simply deletes it from the list of jobs without stopping it.</description></item><item><title>Module hilbish.messages</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/</guid><description>Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.

versions/readline-move/docs/api/index.xml

@@ -1,8 +1,9 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>API on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/</link><description>Recent content in API on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/index.xml" rel="self" type="application/rss+xml"/><item><title>Module bait</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/</guid><description>Introduction Bait is the event emitter for Hilbish. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to pick a unique name!
 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/readline-move/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/</guid><description>Introduction Commander is the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander library in your Hilbish config.
 1local commander = require &amp;#39;commander&amp;#39; 2 3commander.register(&amp;#39;hello&amp;#39;, function(args, sinks) 4 sinks.out:writeln &amp;#39;Hello world!&amp;#39; 5end) 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/readline-move/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</guid><description>Introduction The fs module provides filesystem functions to Hilbish. While Lua&amp;rsquo;s standard library has some I/O functions, they&amp;rsquo;re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.
-Functions abs(path) -&amp;gt; string Returns an absolute version of the path. basename(path) -&amp;gt; string Returns the &amp;ldquo;basename,&amp;rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&amp;rsquo;s directory to dir.</description></item><item><title>Module readline</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</guid><description>Introduction This package is designed to be run independently from murex and at some point it will be separated into it&amp;rsquo;s own git repository (at a stage when I am confident that murex will no longer be the primary driver for features, bugs or other code changes)
+Functions abs(path) -&amp;gt; string Returns an absolute version of the path. basename(path) -&amp;gt; string Returns the &amp;ldquo;basename,&amp;rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&amp;rsquo;s directory to dir.</description></item><item><title>Module readline</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</guid><description>Introduction The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything. The global Hilbish readline instance is usable at hilbish.editor.
-line reader library The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything.</description></item><item><title>Module snail</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</guid><description>Introduction The snail library houses Hilbish&amp;rsquo;s Lua wrapper of its shell script interpreter. It&amp;rsquo;s not very useful other than running shell scripts, which can be done with other Hilbish functions.
+Functions new() -&amp;gt; @Readline Creates a new readline instance. readline.new() -> Readline Creates a new readline instance.
+Parameters This function has no parameters.</description></item><item><title>Module snail</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</guid><description>Introduction The snail library houses Hilbish&amp;rsquo;s Lua wrapper of its shell script interpreter. It&amp;rsquo;s not very useful other than running shell scripts, which can be done with other Hilbish functions.
 Functions new() -&amp;gt; @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance.
 Parameters This function has no parameters.
 Types Snail A Snail is a shell script interpreter instance.

versions/readline-move/index.xml

@@ -50,8 +50,7 @@ Functions setOld(d) Sets the old directory string. recent(idx) Get entry from re
 Functions renderInfoBlock(type, text) Renders an info block. An info block is a block of text with renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting.</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</guid><description>Introduction The fs module provides filesystem functions to Hilbish. While Lua&amp;rsquo;s standard library has some I/O functions, they&amp;rsquo;re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.
 Functions abs(path) -&amp;gt; string Returns an absolute version of the path. basename(path) -&amp;gt; string Returns the &amp;ldquo;basename,&amp;rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&amp;rsquo;s directory to dir.</description></item><item><title>Module hilbish.abbr</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/</guid><description>Introduction The abbr module manages Hilbish abbreviations. These are words that can be replaced with longer command line strings when entered. As an example, git push can be abbreviated to gp. When the user types gp into the command line, after hitting space or enter, it will expand to git push. Abbreviations can be used as an alternative to aliases. They are saved entirely in the history Instead of the aliased form of the same command.</description></item><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&amp;rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
-Functions bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
+Functions bins(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&amp;gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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 deleteByAmount(amount) Deletes characters in the line by the given amount. 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 Hilbish command line. getChar() -&amp;gt; string Reads a keystroke from the user. This is in a format of something like Ctrl-L.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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 as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -&amp;gt; number Returns the amount of commands in the history. hilbish.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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) Creates a new job. This function does not run the job. This function is intended to be all() -&amp;gt; table[@Job] Returns a table of all job objects. disown(id) Disowns a job. This simply deletes it from the list of jobs without stopping it.</description></item><item><title>Module hilbish.messages</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/</guid><description>Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
@@ -64,8 +63,9 @@ A runner is passed the input and has to return a table with these values.</descr
 These are the simple functions hilbish.interval and hilbish.timeout (doc accessible with doc hilbish, or Module hilbish on the Website).
 An example of usage:
 1local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function() 2 print &amp;#39;hello!</description></item><item><title>Module hilbish.userDir</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/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 readline</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</guid><description>Introduction This package is designed to be run independently from murex and at some point it will be separated into it&amp;rsquo;s own git repository (at a stage when I am confident that murex will no longer be the primary driver for features, bugs or other code changes)
+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 readline</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</guid><description>Introduction The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything. The global Hilbish readline instance is usable at hilbish.editor.
-line reader library The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything.</description></item><item><title>Module snail</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</guid><description>Introduction The snail library houses Hilbish&amp;rsquo;s Lua wrapper of its shell script interpreter. It&amp;rsquo;s not very useful other than running shell scripts, which can be done with other Hilbish functions.
+Functions new() -&amp;gt; @Readline Creates a new readline instance. readline.new() -> Readline Creates a new readline instance.
+Parameters This function has no parameters.</description></item><item><title>Module snail</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</guid><description>Introduction The snail library houses Hilbish&amp;rsquo;s Lua wrapper of its shell script interpreter. It&amp;rsquo;s not very useful other than running shell scripts, which can be done with other Hilbish functions.
 Functions new() -&amp;gt; @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance.
 Parameters This function has no parameters.
 Types Snail A Snail is a shell script interpreter instance.