Module snail

Introduction#

The snail library houses Hilbish's Lua wrapper of its shell script interpreter. It's not very useful other than running shell scripts, which can be done with other Hilbish functions.

Functions#

• snail.new() -> @Snail: Creates a new Snail instance.

• snail.validate(input): Checks if input is incomplete. Does not error otherwise.

new#

snail.new() -> @Snail

Creates a new Snail instance.

Parameters#

This function has no parameters.

validate#

snail.validate(input)

Checks if input is incomplete. Does not error otherwise.

Parameters#

string input

Types#

Snail#

A Snail is a shell script interpreter instance.

Methods#

dir(path)#

Changes the directory of the snail instance. The interpreter keeps its set directory even when the Hilbish process changes directory, so this should be called on the hilbish.cd hook.

run(command, streams)#

Runs a shell command. Works the same as hilbish.run, but only accepts a table of streams.