From 1459dc4f4ed908f8bca19abeb3a3701c0b290773 Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Sun, 15 Jun 2025 20:25:22 +0000 Subject: [PATCH] deploy: 49f2bae9e18f5f910016e1e22cf3c5c657e77edd --- docs/api/bait/index.html | 2 +- docs/api/commander/index.html | 2 +- docs/api/fs/index.html | 2 +- docs/api/hilbish/hilbish.abbr/index.html | 2 +- docs/api/hilbish/hilbish.aliases/index.html | 2 +- docs/api/hilbish/hilbish.completion/index.html | 2 +- docs/api/hilbish/hilbish.history/index.html | 2 +- docs/api/hilbish/hilbish.jobs/index.html | 2 +- docs/api/hilbish/hilbish.messages/index.html | 2 +- docs/api/hilbish/hilbish.module/index.html | 2 +- docs/api/hilbish/hilbish.os/index.html | 2 +- docs/api/hilbish/hilbish.processors/index.html | 2 +- docs/api/hilbish/hilbish.runner/index.html | 2 +- docs/api/hilbish/hilbish.timers/index.html | 2 +- docs/api/hilbish/hilbish.userdir/index.html | 2 +- docs/api/hilbish/index.html | 2 +- docs/api/index.html | 2 +- docs/api/index.xml | 4 +++- docs/api/readline/index.html | 2 +- docs/api/snail/index.html | 2 +- docs/api/terminal/index.html | 2 +- docs/api/yarn/index.html | 18 ++++++++++++++++++ docs/completions/index.html | 2 +- docs/faq/index.html | 2 +- docs/features/index.html | 2 +- docs/features/notifications/index.html | 2 +- docs/features/opts/index.html | 2 +- docs/features/runner-mode/index.html | 2 +- docs/getting-started/index.html | 2 +- docs/hooks/command/index.html | 2 +- docs/hooks/hilbish/index.html | 2 +- docs/hooks/index.html | 2 +- docs/hooks/signal/index.html | 2 +- docs/index.html | 2 +- docs/lunacolors/index.html | 2 +- docs/nature/dirs/index.html | 2 +- docs/nature/doc/index.html | 2 +- docs/nature/index.html | 2 +- docs/vim-mode/actions/index.html | 2 +- docs/vim-mode/index.html | 2 +- index.xml | 4 +++- sitemap.xml | 2 +- 42 files changed, 63 insertions(+), 41 deletions(-) create mode 100644 docs/api/yarn/index.html diff --git a/docs/api/bait/index.html b/docs/api/bait/index.html index a34af816..5f1c50f0 100644 --- a/docs/api/bait/index.html +++ b/docs/api/bait/index.html @@ -1,7 +1,7 @@ Module bait — Hilbish

Module bait

the event emitter

Introduction +

Module bait

the event emitter

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 diff --git a/docs/api/commander/index.html b/docs/api/commander/index.html index 334953a9..9e117f3a 100644 --- a/docs/api/commander/index.html +++ b/docs/api/commander/index.html @@ -1,7 +1,7 @@ Module commander — Hilbish

Module commander

library for custom commands

Introduction +

Module commander

library for custom commands

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 diff --git a/docs/api/fs/index.html b/docs/api/fs/index.html index a0c2d7cc..5aea7540 100644 --- a/docs/api/fs/index.html +++ b/docs/api/fs/index.html @@ -1,7 +1,7 @@ Module fs — Hilbish

Module fs

filesystem interaction and functionality library

Introduction +

Module fs

filesystem interaction and functionality library

Introduction

The fs module provides filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.

Functions diff --git a/docs/api/hilbish/hilbish.abbr/index.html b/docs/api/hilbish/hilbish.abbr/index.html index 4c089255..565b8c92 100644 --- a/docs/api/hilbish/hilbish.abbr/index.html +++ b/docs/api/hilbish/hilbish.abbr/index.html @@ -1,7 +1,7 @@ Module hilbish.abbr — Hilbish

Module hilbish.abbr

command line abbreviations

Introduction +

Module hilbish.abbr

command line abbreviations

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 diff --git a/docs/api/hilbish/hilbish.aliases/index.html b/docs/api/hilbish/hilbish.aliases/index.html index d31c0898..8ffd1e24 100644 --- a/docs/api/hilbish/hilbish.aliases/index.html +++ b/docs/api/hilbish/hilbish.aliases/index.html @@ -1,7 +1,7 @@ Module hilbish.aliases — Hilbish

Module hilbish.aliases

command aliasing

Introduction +

Module hilbish.aliases

command aliasing

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() -> table[string, string]Get a table of all aliases, with string keys as the alias and the value as the command.
resolve(alias) -> string?Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist.

hilbish.aliases.add(alias, cmd) diff --git a/docs/api/hilbish/hilbish.completion/index.html b/docs/api/hilbish/hilbish.completion/index.html index c6d01477..8738b70a 100644 --- a/docs/api/hilbish/hilbish.completion/index.html +++ b/docs/api/hilbish/hilbish.completion/index.html @@ -1,7 +1,7 @@ Module hilbish.completion — Hilbish

Module hilbish.completion

tab completions

Introduction +

Module hilbish.completion

tab completions

Introduction

The completions interface deals with tab completions.

Functions

bins(query, ctx, fields) -> entries (table), prefix (string)Return binaries/executables based on the provided parameters.
call(name, query, ctx, fields) -> 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) -> entries (table), prefix (string)Returns file matches based on the provided parameters.
handler(line, pos)This function contains the general completion handler for Hilbish. This function handles

hilbish.completion.bins(query, ctx, fields) -> entries (table), prefix (string)

Return binaries/executables based on the provided parameters.
This function is meant to be used as a helper in a command completion handler.

Parameters diff --git a/docs/api/hilbish/hilbish.history/index.html b/docs/api/hilbish/hilbish.history/index.html index 320d9483..198d588c 100644 --- a/docs/api/hilbish/hilbish.history/index.html +++ b/docs/api/hilbish/hilbish.history/index.html @@ -1,7 +1,7 @@ Module hilbish.history — Hilbish

Module hilbish.history

command history

Introduction +

Module hilbish.history

command history

Introduction

The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.

Functions diff --git a/docs/api/hilbish/hilbish.jobs/index.html b/docs/api/hilbish/hilbish.jobs/index.html index 62441672..8dc9bd3c 100644 --- a/docs/api/hilbish/hilbish.jobs/index.html +++ b/docs/api/hilbish/hilbish.jobs/index.html @@ -1,7 +1,7 @@ Module hilbish.jobs — Hilbish

Module hilbish.jobs

background job management

Introduction +

Module hilbish.jobs

background job management

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() -> 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.
get(id) -> @JobGet a job object via its ID.
last() -> @JobReturns the last added job to the table.

hilbish.jobs.add(cmdstr, args, execPath) diff --git a/docs/api/hilbish/hilbish.messages/index.html b/docs/api/hilbish/hilbish.messages/index.html index bac5ac69..a6971230 100644 --- a/docs/api/hilbish/hilbish.messages/index.html +++ b/docs/api/hilbish/hilbish.messages/index.html @@ -1,7 +1,7 @@ Module hilbish.messages — Hilbish

Module hilbish.messages

simplistic message passing

Introduction +

Module hilbish.messages

simplistic message passing

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: diff --git a/docs/api/hilbish/hilbish.module/index.html b/docs/api/hilbish/hilbish.module/index.html index c6faec22..45c900d7 100644 --- a/docs/api/hilbish/hilbish.module/index.html +++ b/docs/api/hilbish/hilbish.module/index.html @@ -1,7 +1,7 @@ Module hilbish.module — Hilbish

Module hilbish.module

native module loading

Introduction +

Module hilbish.module

native module loading

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 diff --git a/docs/api/hilbish/hilbish.os/index.html b/docs/api/hilbish/hilbish.os/index.html index 9d675379..a11d2985 100644 --- a/docs/api/hilbish/hilbish.os/index.html +++ b/docs/api/hilbish/hilbish.os/index.html @@ -1,7 +1,7 @@ Module hilbish.os — Hilbish

Module hilbish.os

operating system info

Introduction +

Module hilbish.os

operating system info

Introduction

Provides simple text information properties about the current operating system. This mainly includes the name and version.

Static module fields

familyFamily name of the current OS
namePretty name of the current OS
versionVersion of the current OS

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.processors/index.html b/docs/api/hilbish/hilbish.processors/index.html index 61766b25..5ff44882 100644 --- a/docs/api/hilbish/hilbish.processors/index.html +++ b/docs/api/hilbish/hilbish.processors/index.html @@ -1,7 +1,7 @@ Module hilbish.processors — Hilbish

Module hilbish.processors

No description.

hilbish.processors.add() +

Module hilbish.processors

No description.

hilbish.processors.add()

Parameters

This function has no parameters.

hilbish.processors.execute()

Run all command processors, in order by priority. diff --git a/docs/api/hilbish/hilbish.runner/index.html b/docs/api/hilbish/hilbish.runner/index.html index af22339b..dd58dfec 100644 --- a/docs/api/hilbish/hilbish.runner/index.html +++ b/docs/api/hilbish/hilbish.runner/index.html @@ -1,7 +1,7 @@ Module hilbish.runner — Hilbish

Module hilbish.runner

interactive command runner customization

Introduction +

Module hilbish.runner

interactive command runner customization

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 diff --git a/docs/api/hilbish/hilbish.timers/index.html b/docs/api/hilbish/hilbish.timers/index.html index e13c69dc..12000f3c 100644 --- a/docs/api/hilbish/hilbish.timers/index.html +++ b/docs/api/hilbish/hilbish.timers/index.html @@ -1,7 +1,7 @@ Module hilbish.timers — Hilbish

Module hilbish.timers

timeout and interval API

Introduction +

Module hilbish.timers

timeout and interval API

Introduction

If you ever want to run a piece of code on a timed interval, or want to wait a few seconds, you don’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 diff --git a/docs/api/hilbish/hilbish.userdir/index.html b/docs/api/hilbish/hilbish.userdir/index.html index 0074caf6..0fe1bdef 100644 --- a/docs/api/hilbish/hilbish.userdir/index.html +++ b/docs/api/hilbish/hilbish.userdir/index.html @@ -1,7 +1,7 @@ Module hilbish.userDir — Hilbish

Module hilbish.userDir

user-related directories

Introduction +

Module hilbish.userDir

user-related directories

Introduction

This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user’s preferred directories for configs and data.

Static module fields diff --git a/docs/api/hilbish/index.html b/docs/api/hilbish/index.html index cb80dd79..b5300e88 100644 --- a/docs/api/hilbish/index.html +++ b/docs/api/hilbish/index.html @@ -1,7 +1,7 @@ Module hilbish — Hilbish

Module hilbish

the core Hilbish API

Introduction +

Module hilbish

the core Hilbish API

Introduction

The Hilbish module includes the core API, containing interfaces and functions which directly relate to shell functionality.

Functions

alias(cmd, orig)Sets an alias, with a name of cmd to another command.
appendPath(dir)Appends the provided dir to the command path ($PATH)
complete(scope, cb)Registers a completion handler for the specified scope.
cwd() -> stringReturns the current directory of the shell.
exec(cmd)Replaces the currently running Hilbish instance with the supplied command.
goro(fn)Puts fn in a Goroutine.
highlighter(line)Line highlighter handler.
hinter(line, pos)The command line hint handler. It gets called on every key insert to
inputMode(mode)Sets the input mode for Hilbish’s line reader.
interval(cb, time) -> @TimerRuns the cb function every specified amount of time.
multiprompt(str)Changes the text prompt when Hilbish asks for more input.
prependPath(dir)Prepends dir to $PATH.
prompt(str, typ)Changes the shell prompt to the provided string.
read(prompt) -> input (string)Read input from the user, using Hilbish’s line editor/input reader.
timeout(cb, time) -> @TimerExecuted the cb function after a period of time.
which(name) -> stringChecks if name is a valid command.
runnerMode(mode)Sets the execution/runner mode for interactive Hilbish.
run(cmd, streams)Runs cmd in Hilbish’s shell script interpreter.

Static module fields diff --git a/docs/api/index.html b/docs/api/index.html index 75fdcbc5..02d2e2c2 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -1,5 +1,5 @@ API — Hilbish

API

Welcome to the API documentation for Hilbish. This documents Lua functions +

API

Welcome to the API documentation for Hilbish. This documents Lua functions provided by Hilbish.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/index.xml b/docs/api/index.xml index e3411958..9e321268 100644 --- a/docs/api/index.xml +++ b/docs/api/index.xml @@ -9,4 +9,6 @@ Parameters This function has no parameters. Types Snail A Snail is a shell script interpreter instance. Methods dir(path) Changes the directory of the snail instance.Module terminalhttps://rosettea.github.io/Hilbish/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/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 +Parameters This function has no parameters.Module yarnhttps://rosettea.github.io/Hilbish/docs/api/yarn/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/api/yarn/Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another. +Example: +1local yarn = require 'yarn' 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t 'printing from another lua state!' Functions thread(fun) -> @Thread Creates a new, fresh Yarn thread. \ No newline at end of file diff --git a/docs/api/readline/index.html b/docs/api/readline/index.html index 938d6d66..c4df59a8 100644 --- a/docs/api/readline/index.html +++ b/docs/api/readline/index.html @@ -1,7 +1,7 @@ Module readline — Hilbish

Module readline

line reader library

Introduction +

Module readline

line reader library

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, diff --git a/docs/api/snail/index.html b/docs/api/snail/index.html index cc629db1..23398f53 100644 --- a/docs/api/snail/index.html +++ b/docs/api/snail/index.html @@ -1,7 +1,7 @@ Module snail — Hilbish

Module snail

shell script interpreter library

Introduction +

Module snail

shell script interpreter library

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 diff --git a/docs/api/terminal/index.html b/docs/api/terminal/index.html index 32fef02c..76b0374d 100644 --- a/docs/api/terminal/index.html +++ b/docs/api/terminal/index.html @@ -1,7 +1,7 @@ Module terminal — Hilbish

Module terminal

low level terminal library

Introduction +

Module terminal

low level terminal library

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 diff --git a/docs/api/yarn/index.html b/docs/api/yarn/index.html new file mode 100644 index 00000000..b0a12e43 --- /dev/null +++ b/docs/api/yarn/index.html @@ -0,0 +1,18 @@ +Module yarn — Hilbish +

Module yarn

multi threading library

Introduction +

Yarn is a simple multithreading library. Threads are individual Lua states, +so they do NOT share the same environment as the code that runs the thread. +Bait and Commanders are shared though, so you can throw hooks from 1 thread to another.

Example:

1local yarn = require 'yarn'
+2
+3-- calling t will run the yarn thread.
+4local t = yarn.thread(print)
+5t 'printing from another lua state!'
+

Functions +

thread(fun) -> @ThreadCreates a new, fresh Yarn thread.

yarn.thread(fun) -> Thread +

Creates a new, fresh Yarn thread.
fun is the function that will run in the thread.

Parameters +

This function has no parameters.

Types +

Thread +

Methods +

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/completions/index.html b/docs/completions/index.html index 3efc4efe..7a27d6b3 100644 --- a/docs/completions/index.html +++ b/docs/completions/index.html @@ -1,7 +1,7 @@ Completions — Hilbish

Completions

Tab completion for commands.

Completions for commands can be created with the hilbish.complete +

Completions

Tab completion for commands.

Completions for commands can be created with the hilbish.complete function. See the link for how to use it.

To create completions for a command is simple. The callback will be passed 3 parameters: