From 4374de926cc42ce7c8a86d32de526b738683571a Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Thu, 3 Apr 2025 04:41:14 +0000 Subject: [PATCH] deploy: fa467e04ab9f06e2fa88ad3912e6781b23f1fe4c --- versions/abbr/docs/api/bait/index.html | 2 +- versions/abbr/docs/api/commander/index.html | 2 +- versions/abbr/docs/api/fs/index.html | 2 +- .../docs/api/hilbish/hilbish.abbr/index.html | 12 ++-- .../api/hilbish/hilbish.aliases/index.html | 2 +- .../api/hilbish/hilbish.completion/index.html | 2 +- .../api/hilbish/hilbish.editor/index.html | 2 +- .../api/hilbish/hilbish.history/index.html | 2 +- .../docs/api/hilbish/hilbish.jobs/index.html | 2 +- .../api/hilbish/hilbish.messages/index.html | 14 ++-- .../api/hilbish/hilbish.module/index.html | 2 +- .../docs/api/hilbish/hilbish.os/index.html | 2 +- .../api/hilbish/hilbish.runner/index.html | 50 ++++++++------ .../api/hilbish/hilbish.timers/index.html | 2 +- .../api/hilbish/hilbish.userdir/index.html | 2 +- versions/abbr/docs/api/hilbish/index.html | 69 +++++++++++-------- versions/abbr/docs/api/index.html | 2 +- versions/abbr/docs/api/index.xml | 6 +- versions/abbr/docs/api/snail/index.html | 17 +++++ versions/abbr/docs/api/terminal/index.html | 2 +- versions/abbr/docs/completions/index.html | 2 +- versions/abbr/docs/faq/index.html | 2 +- versions/abbr/docs/features/index.html | 2 +- .../docs/features/notifications/index.html | 2 +- versions/abbr/docs/features/opts/index.html | 2 +- .../abbr/docs/features/runner-mode/index.html | 2 +- versions/abbr/docs/getting-started/index.html | 2 +- versions/abbr/docs/hooks/command/index.html | 2 +- versions/abbr/docs/hooks/hilbish/index.html | 12 +++- versions/abbr/docs/hooks/index.html | 2 +- versions/abbr/docs/hooks/signal/index.html | 2 +- versions/abbr/docs/index.html | 2 +- versions/abbr/docs/lunacolors/index.html | 2 +- versions/abbr/docs/nature/dirs/index.html | 24 +++---- versions/abbr/docs/nature/doc/index.html | 18 ++--- versions/abbr/docs/nature/index.html | 2 +- versions/abbr/docs/nature/index.xml | 4 +- .../abbr/docs/vim-mode/actions/index.html | 2 +- versions/abbr/docs/vim-mode/index.html | 2 +- versions/abbr/index.xml | 10 ++- versions/abbr/sitemap.xml | 2 +- 41 files changed, 172 insertions(+), 124 deletions(-) create mode 100644 versions/abbr/docs/api/snail/index.html diff --git a/versions/abbr/docs/api/bait/index.html b/versions/abbr/docs/api/bait/index.html index 49c05bd..21a15f1 100644 --- a/versions/abbr/docs/api/bait/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/commander/index.html b/versions/abbr/docs/api/commander/index.html index ecf3c72..d92dc38 100644 --- a/versions/abbr/docs/api/commander/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/fs/index.html b/versions/abbr/docs/api/fs/index.html index 2b07d1b..a61e488 100644 --- a/versions/abbr/docs/api/fs/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.abbr/index.html b/versions/abbr/docs/api/hilbish/hilbish.abbr/index.html index 508648e..d2c7705 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.abbr/index.html +++ b/versions/abbr/docs/api/hilbish/hilbish.abbr/index.html @@ -1,21 +1,21 @@ 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 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.

Functions -

add(abbr, expandedfunction, opts)
remove(abbr)Removes the named abbr.

hilbish.abbr.remove(abbr) -

Removes the named abbr.

Parameters -

abbr string

hilbish.abbr.add(abbr, expanded|function, opts) +

remove(abbr)Removes the named abbr.
add(abbr, expandedfunction, opts)

hilbish.abbr.add(abbr, expanded|function, opts)

Adds an abbreviation. The abbr is the abbreviation itself, while expanded is what the abbreviation should expand to. It can be either a function or a string. If it is a function, it will expand to what the function returns. opts is a table that accepts 1 key: anywhere. opts.anywhere defines whether the abbr expands anywhere in the command line or not, -whereas the default behavior is only at the beginning of the line

Parameters -

abbr string

expanded|function string

opts table

Want to help improve this page? Create an issue.

\ No newline at end of file +whereas the default behavior is only at the beginning of the line

Parameters +

abbr string

expanded|function string

opts table

hilbish.abbr.remove(abbr) +

Removes the named abbr.

Parameters +

abbr string

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/abbr/docs/api/hilbish/hilbish.aliases/index.html b/versions/abbr/docs/api/hilbish/hilbish.aliases/index.html index ce10655..e659166 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.aliases/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.completion/index.html b/versions/abbr/docs/api/hilbish/hilbish.completion/index.html index 173e93a..fb8c64a 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.completion/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.editor/index.html b/versions/abbr/docs/api/hilbish/hilbish.editor/index.html index 99af348..abcbc23 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.editor/index.html +++ b/versions/abbr/docs/api/hilbish/hilbish.editor/index.html @@ -1,7 +1,7 @@ Module hilbish.editor — Hilbish

Module hilbish.editor

interactions for Hilbish's line reader

Introduction +

Module hilbish.editor

interactions for Hilbish's line reader

Introduction

The hilbish.editor interface provides functions to directly interact with the line editor in use.

Functions

deleteByAmount(amount)Deletes characters in the line by the given amount.
getLine() -> stringReturns the current input line.
getVimRegister(register) -> stringReturns the text that is at the register.
insert(text)Inserts text into the Hilbish command line.
getChar() -> stringReads a keystroke from the user. This is in a format of something like Ctrl-L.
setVimRegister(register, text)Sets the vim register at register to hold the passed text.

hilbish.editor.deleteByAmount(amount) diff --git a/versions/abbr/docs/api/hilbish/hilbish.history/index.html b/versions/abbr/docs/api/hilbish/hilbish.history/index.html index 5f652f9..d0aea4e 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.history/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.jobs/index.html b/versions/abbr/docs/api/hilbish/hilbish.jobs/index.html index 0793a13..c2e4c93 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.jobs/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.messages/index.html b/versions/abbr/docs/api/hilbish/hilbish.messages/index.html index d80d54b..a3f8a55 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.messages/index.html +++ b/versions/abbr/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: @@ -11,7 +11,7 @@ The hilbish.message type is a table with the following keys: 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.

Functions -

unreadCount()Returns the amount of unread messages.
readAll()Marks all messages as read.
send(message)Sends a message.
read(idx)Marks a message at idx as read.
delete(idx)Deletes the message at idx.
clear()Deletes all messages.
all()Returns all messages.

hilbish.messages.all() +

unreadCount()Returns the amount of unread messages.
send(message)Sends a message.
readAll()Marks all messages as read.
read(idx)Marks a message at idx as read.
delete(idx)Deletes the message at idx.
clear()Deletes all messages.
all()Returns all messages.

hilbish.messages.all()

Returns all messages.

Parameters

This function has no parameters.

hilbish.messages.clear()

Deletes all messages.

Parameters @@ -19,10 +19,10 @@ The hilbish.message type is a table with the following keys:

Deletes the message at idx.

Parameters

idx number

hilbish.messages.read(idx)

Marks a message at idx as read.

Parameters -

idx number

hilbish.messages.send(message) -

Sends a message.

Parameters -

message hilbish.message

hilbish.messages.readAll() -

Marks all messages as read.

Parameters -

This function has no parameters.

hilbish.messages.unreadCount() +

idx number

hilbish.messages.readAll() +

Marks all messages as read.

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.unreadCount()

Returns the amount of unread messages.

Parameters

This function has no parameters.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/abbr/docs/api/hilbish/hilbish.module/index.html b/versions/abbr/docs/api/hilbish/hilbish.module/index.html index 536aee1..2da7560 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.module/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.os/index.html b/versions/abbr/docs/api/hilbish/hilbish.os/index.html index 4a980ea..549969a 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.os/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.runner/index.html b/versions/abbr/docs/api/hilbish/hilbish.runner/index.html index 6e853e8..70fe6fc 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.runner/index.html +++ b/versions/abbr/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 @@ -28,26 +28,34 @@ shell script if fennel eval has an error.

11	return hilbish.runner.sh(input)
 12end)

Functions -

setMode(cb)This is the same as the hilbish.runnerMode function.
lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile
sh(cmd)Runs a command in Hilbish’s shell script interpreter.
exec(cmd, runnerName)Executes cmd with a runner.
set(name, runner)Sets a runner by name. The difference between this function and
get(name)Get a runner by name.
add(name, runner)Adds a runner to the table of available runners.
setCurrent(name)Sets Hilbish’s runner mode by name.
getCurrent()Returns the current runner by name.

hilbish.runner.setMode(cb) -

This is the same as the hilbish.runnerMode 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,
as the higher level functions listed below this will handle it.

Parameters -

function cb

hilbish.runner.lua(cmd) -

Evaluates cmd as Lua input. This is the same as using dofile
or load, but is appropriated for the runner interface.

Parameters -

string cmd

hilbish.runner.sh(cmd) -

Runs a command in Hilbish’s shell script interpreter.
This is the equivalent of using source.

Parameters -

string cmd

hilbish.runner.getCurrent() -

Returns the current runner by name.

Parameters -

This function has no parameters.

hilbish.runner.setCurrent(name) -

Sets Hilbish’s runner mode by name.

Parameters -

name string

hilbish.runner.add(name, runner) +

lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile
sh()nil
setMode(mode)NOTE: This function is deprecated and will be removed in 3.0
setCurrent(name)Sets Hilbish’s runner mode by name.
set(name, runner)Sets a runner by name. The difference between this function and
run(input, priv)Runs input with the currently set Hilbish runner.
getCurrent()Returns the current runner by name.
get(name)Get a runner by name.
exec(cmd, runnerName)Executes cmd with a runner.
add(name, runner)Adds a runner to the table of available runners.

hilbish.runner.lua(cmd) +

Evaluates cmd as Lua input. This is the same as using dofile
or load, but is appropriated for the runner interface.

Parameters +

string cmd

hilbish.runner.add(name, runner)

Adds a runner to the table of available runners. -If runner is a table, it must have the run function in it.

Parameters -

name string
Name of the runner

runner function|table

hilbish.runner.get(name) -

Get a runner by name.

Parameters -

name string
Name of the runner to retrieve.

hilbish.runner.set(name, runner) +If runner is a table, it must have the run function in it.

Parameters +

name string
Name of the runner

runner function|table

hilbish.runner.exec(cmd, runnerName) +

Executes cmd with a runner. +If runnerName is not specified, it uses the default Hilbish runner.

Parameters +

cmd string

runnerName string?

hilbish.runner.get(name) +

Get a runner by name.

Parameters +

name string
Name of the runner to retrieve.

hilbish.runner.getCurrent() +

Returns the current runner by name.

Parameters +

This function has no parameters.

hilbish.runner.run(input, priv) +

Runs input with the currently set Hilbish runner. +This method is how Hilbish executes commands. +priv is an optional boolean used to state if the input should be saved to history.

Parameters +

input string

priv bool

hilbish.runner.set(name, runner)

Sets a runner by name. The difference between this function and add, is set will not check if the named runner exists. -The runner table must have the run function in it.

Parameters -

name string

runner table

hilbish.runner.exec(cmd, runnerName) -

Executes cmd with a runner. -If runnerName is not specified, it uses the default Hilbish runner.

Parameters -

cmd string

runnerName string?

Want to help improve this page? Create an issue.

\ No newline at end of file +The runner table must have the run function in it.

Parameters +

name string

runner table

hilbish.runner.setCurrent(name) +

Sets Hilbish’s runner mode by name.

Parameters +

name string

hilbish.runner.setMode(mode) +

NOTE: This function is deprecated and will be removed in 3.0 +Use hilbish.runner.setCurrent instead. +This is the same as the hilbish.runnerMode function. +It takes a callback, which will be used to execute all interactive input. +Or a string which names the runner mode to use.

Parameters +

mode string|function

hilbish.runner.sh() +

Parameters +

This function has no parameters.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/abbr/docs/api/hilbish/hilbish.timers/index.html b/versions/abbr/docs/api/hilbish/hilbish.timers/index.html index 8e2bf8f..d9ea315 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.timers/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/hilbish.userdir/index.html b/versions/abbr/docs/api/hilbish/hilbish.userdir/index.html index 2451ace..98fef35 100644 --- a/versions/abbr/docs/api/hilbish/hilbish.userdir/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/hilbish/index.html b/versions/abbr/docs/api/hilbish/index.html index 9462719..718692e 100644 --- a/versions/abbr/docs/api/hilbish/index.html +++ b/versions/abbr/docs/api/hilbish/index.html @@ -1,10 +1,10 @@ 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.
run(cmd, streams) -> exitCode (number), stdout (string), stderr (string)Runs cmd in Hilbish’s shell script interpreter.
runnerMode(mode)Sets the execution/runner mode for interactive Hilbish.
timeout(cb, time) -> @TimerExecuted the cb function after a period of time.
which(name) -> stringChecks if name is a valid command.

Static module fields +

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

verThe version of Hilbish
goVersionThe version of Go that Hilbish was compiled with
userUsername of the user
hostHostname of the machine
dataDirDirectory for Hilbish data files, including the docs and default modules
interactiveIs Hilbish in an interactive shell?
loginIs Hilbish the login shell?
vimModeCurrent Vim input mode of Hilbish (will be nil if not in Vim input mode)
exitCodeExit code of the last executed command

hilbish.alias(cmd, orig)

Sets an alias, with a name of cmd to another command.

Parameters

string cmd
Name of the alias

string orig
Command that will be aliased

Example @@ -105,34 +105,13 @@ interfaces and functions which directly relate to shell functionality.

5-- prompt: user@hostname: ~/directory $

hilbish.read(prompt) -> input (string)

Read input from the user, using Hilbish’s line editor/input reader.
This is a separate instance from the one Hilbish actually uses.
Returns input, will be nil if Ctrl-D is pressed, or an error occurs.

Parameters -

string prompt?
Text to print before input, can be empty.

hilbish.run(cmd, streams) -> exitCode (number), stdout (string), stderr (string) -

Runs cmd in Hilbish’s shell script interpreter.
The streams parameter specifies the output and input streams the command should use.
For example, to write command output to a sink.
As a table, the caller can directly specify the standard output, error, and input
streams of the command with the table keys out, err, and input respectively.
As a boolean, it specifies whether the command should use standard output or return its output streams.

Parameters -

string cmd

table|boolean streams

Example -
 1
- 2// This code is the same as `ls -l | wc -l`
- 3local fs = require 'fs'
- 4local pr, pw = fs.pipe()
- 5hilbish.run('ls -l', {
- 6	stdout = pw,
- 7	stderr = pw,
- 8})
- 9
-10pw:close()
-11
-12hilbish.run('wc -l', {
-13	stdin = pr
-14})
-

hilbish.runnerMode(mode) -

Sets the execution/runner mode for interactive Hilbish.
This determines whether Hilbish wll try to run input as Lua
and/or sh or only do one of either.
Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
sh, and lua. It also accepts a function, to which if it is passed one
will call it to execute user input instead.
Read about runner mode -for more information.

Parameters -

string|function mode

hilbish.timeout(cb, time) -> Timer -

Executed the cb function after a period of time.
This creates a Timer that starts ticking immediately.

Parameters -

function cb

number time
Time to run in milliseconds.

hilbish.which(name) -> string -

Checks if name is a valid command.
Will return the path of the binary, or a basename if it’s a commander.

Parameters -

string name

Types +

string prompt?
Text to print before input, can be empty.

hilbish.timeout(cb, time) -> Timer +

Executed the cb function after a period of time.
This creates a Timer that starts ticking immediately.

Parameters +

function cb

number time
Time to run in milliseconds.

hilbish.which(name) -> string +

Checks if name is a valid command.
Will return the path of the binary, or a basename if it’s a commander.

Parameters +

string name

Types

Sink -

A sink is a structure that has input and/or output to/from -a desination.

Methods +

A sink is a structure that has input and/or output to/from a desination.

Methods

autoFlush(auto)

Sets/toggles the option of automatically flushing output. A call with no argument will toggle the value.

flush() @@ -140,4 +119,34 @@ A call with no argument will toggle the value.

flu

Reads a liine of input from the sink.

readAll() -> string

Reads all input from the sink.

write(str)

Writes data to a sink.

writeln(str) -

Writes data to a sink with a newline at the end.

Want to help improve this page? Create an issue.

\ No newline at end of file +

Writes data to a sink with a newline at the end.

hilbish.run(cmd, streams) +

Runs cmd in Hilbish’s shell script interpreter. +The streams parameter specifies the output and input streams the command should use. +For example, to write command output to a sink. +As a table, the caller can directly specify the standard output, error, and input +streams of the command with the table keys out, err, and input respectively. +As a boolean, it specifies whether the command should use standard output or return its output streams.

Parameters +

cmd string

streams table|boolean

Example +
 1-- This code is the same as `ls -l | wc -l`
+ 2local fs = require 'fs'
+ 3local pr, pw = fs.pipe()
+ 4hilbish.run('ls -l', {
+ 5	stdout = pw,
+ 6	stderr = pw,
+ 7})
+ 8pw:close()
+ 9hilbish.run('wc -l', {
+10	stdin = pr
+11})
+

hilbish.runnerMode(mode) +

Sets the execution/runner mode for interactive Hilbish. +NOTE: This function is deprecated and will be removed in 3.0 +Use hilbish.runner.setCurrent instead. +This determines whether Hilbish wll try to run input as Lua +and/or sh or only do one of either. +Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua), +sh, and lua. It also accepts a function, to which if it is passed one +will call it to execute user input instead. +Read about runner mode +for more information.

Parameters +

mode string|function

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/abbr/docs/api/index.html b/versions/abbr/docs/api/index.html index 6aacdbd..6817e7f 100644 --- a/versions/abbr/docs/api/index.html +++ b/versions/abbr/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/versions/abbr/docs/api/index.xml b/versions/abbr/docs/api/index.xml index a05e969..fba93ab 100644 --- a/versions/abbr/docs/api/index.xml +++ b/versions/abbr/docs/api/index.xml @@ -1,6 +1,10 @@ API on Hilbishhttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/Recent content in API on HilbishHugo -- gohugo.ioen-usModule baithttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/bait/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/abbr/docs/api/bait/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’s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.Module commanderhttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/commander/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/abbr/docs/api/commander/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 'commander' 2 3commander.register('hello', function(args, sinks) 4 sinks.out:writeln 'Hello world!' 5end) In this example, a command with the name of hello is created that will print Hello world!Module fshttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/abbr/docs/api/fs/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 abs(path) -> string Returns an absolute version of the path. basename(path) -> string Returns the “basename,” or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish’s directory to dir.Module terminalhttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/abbr/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. +Functions abs(path) -> string Returns an absolute version of the path. basename(path) -> string Returns the “basename,” or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish’s directory to dir.Module snailhttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/abbr/docs/api/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 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 dir(path) Changes the directory of the snail instance.Module terminalhttps://rosettea.github.io/Hilbish/versions/abbr/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/abbr/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/abbr/docs/api/snail/index.html b/versions/abbr/docs/api/snail/index.html new file mode 100644 index 0000000..02ed49c --- /dev/null +++ b/versions/abbr/docs/api/snail/index.html @@ -0,0 +1,17 @@ +Module snail — Hilbish +

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 +

new() -> @SnailCreates 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 +

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/abbr/docs/api/terminal/index.html b/versions/abbr/docs/api/terminal/index.html index 37e5fd5..ded4b45 100644 --- a/versions/abbr/docs/api/terminal/index.html +++ b/versions/abbr/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/versions/abbr/docs/completions/index.html b/versions/abbr/docs/completions/index.html index c3f0d34..7fe3bc5 100644 --- a/versions/abbr/docs/completions/index.html +++ b/versions/abbr/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: