From 6d3cf1ce8cbd337c117d7fe3772a5bfb16ba3f28 Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Thu, 3 Apr 2025 04:13:22 +0000 Subject: [PATCH] deploy: 90e6afc22fbd1eb8d65400c1634824ddf1a6fe28 --- versions/snail/docs/api/index.xml | 2 +- versions/snail/docs/api/snail/index.html | 7 +++++-- versions/snail/index.xml | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/versions/snail/docs/api/index.xml b/versions/snail/docs/api/index.xml index 76bad37..4ae5562 100644 --- a/versions/snail/docs/api/index.xml +++ b/versions/snail/docs/api/index.xml @@ -5,6 +5,6 @@ Functions abs(path) -> string Returns an absolute version of the path. ba Functions new() -> @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. -Methods run(command, streams) Runs a shell command.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. +Methods dir(path) Changes the directory of the snail instance.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/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 into 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. \ No newline at end of file diff --git a/versions/snail/docs/api/snail/index.html b/versions/snail/docs/api/snail/index.html index ef923fd..b1c719e 100644 --- a/versions/snail/docs/api/snail/index.html +++ b/versions/snail/docs/api/snail/index.html @@ -10,5 +10,8 @@ Hilbish functions.

Functions

This function has no parameters.

Types

Snail

A Snail is a shell script interpreter instance.

Methods -

run(command, streams) -

Runs a shell command. Works the same as hilbish.run.

Want to help improve this page? Create an issue.

\ No newline at end of file +
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.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/snail/index.xml b/versions/snail/index.xml index 65f9fc5..f656927 100644 --- a/versions/snail/index.xml +++ b/versions/snail/index.xml @@ -66,7 +66,7 @@ Static module fields config The user’s config directory data The user& Functions new() -> @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. -Methods run(command, streams) Runs a shell command.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. +Methods dir(path) Changes the directory of the snail instance.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/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 into 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.Notificationhttps://rosettea.github.io/Hilbish/versions/snail/docs/features/notifications/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/features/notifications/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: