From a08bd79f6125273772389d9b20eebb2f843b9f26 Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Sun, 15 Jun 2025 16:39:46 +0000 Subject: [PATCH] deploy: 878291de653860f5dc298f005be5351a8ded205c --- .../readline-move/docs/api/bait/index.html | 2 +- .../docs/api/commander/index.html | 2 +- versions/readline-move/docs/api/fs/index.html | 2 +- .../docs/api/hilbish/hilbish.abbr/index.html | 21 +++++++++++ .../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 | 28 +++++++++++++++ .../api/hilbish/hilbish.module/index.html | 2 +- .../docs/api/hilbish/hilbish.os/index.html | 2 +- .../api/hilbish/hilbish.processors/index.html | 10 ++++++ .../api/hilbish/hilbish.runner/index.html | 34 ++++++++++++++++-- .../api/hilbish/hilbish.timers/index.html | 2 +- .../api/hilbish/hilbish.userdir/index.html | 2 +- .../readline-move/docs/api/hilbish/index.html | 36 +++++++++++++++++-- .../readline-move/docs/api/hilbish/index.xml | 8 +++-- versions/readline-move/docs/api/index.html | 2 +- .../docs/api/readline/index.html | 2 +- .../readline-move/docs/api/snail/index.html | 2 +- .../docs/api/terminal/index.html | 2 +- .../readline-move/docs/completions/index.html | 2 +- versions/readline-move/docs/faq/index.html | 2 +- .../readline-move/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 +- versions/readline-move/docs/hooks/index.html | 2 +- .../docs/hooks/signal/index.html | 2 +- versions/readline-move/docs/index.html | 2 +- .../readline-move/docs/lunacolors/index.html | 2 +- .../readline-move/docs/nature/dirs/index.html | 2 +- .../readline-move/docs/nature/doc/index.html | 2 +- versions/readline-move/docs/nature/index.html | 2 +- .../docs/vim-mode/actions/index.html | 2 +- .../readline-move/docs/vim-mode/index.html | 2 +- versions/readline-move/index.xml | 8 +++-- versions/readline-move/sitemap.xml | 2 +- 42 files changed, 168 insertions(+), 47 deletions(-) create mode 100644 versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html create mode 100644 versions/readline-move/docs/api/hilbish/hilbish.messages/index.html create mode 100644 versions/readline-move/docs/api/hilbish/hilbish.processors/index.html diff --git a/versions/readline-move/docs/api/bait/index.html b/versions/readline-move/docs/api/bait/index.html index cf4e5662..b6b48d14 100644 --- a/versions/readline-move/docs/api/bait/index.html +++ b/versions/readline-move/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/readline-move/docs/api/commander/index.html b/versions/readline-move/docs/api/commander/index.html index 6a7825f5..5d9d1796 100644 --- a/versions/readline-move/docs/api/commander/index.html +++ b/versions/readline-move/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/readline-move/docs/api/fs/index.html b/versions/readline-move/docs/api/fs/index.html index dba2fae2..7c2f9b2c 100644 --- a/versions/readline-move/docs/api/fs/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.abbr/index.html b/versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html new file mode 100644 index 00000000..ba424c3b --- /dev/null +++ b/versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html @@ -0,0 +1,21 @@ +Module hilbish.abbr — Hilbish +

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 +

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

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/readline-move/docs/api/hilbish/hilbish.aliases/index.html b/versions/readline-move/docs/api/hilbish/hilbish.aliases/index.html index 25037494..d421e945 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.aliases/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.completion/index.html b/versions/readline-move/docs/api/hilbish/hilbish.completion/index.html index 5ffdc133..0a5b698c 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.completion/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.editor/index.html b/versions/readline-move/docs/api/hilbish/hilbish.editor/index.html index dd5a1197..6315683e 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.editor/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.history/index.html b/versions/readline-move/docs/api/hilbish/hilbish.history/index.html index 91122846..42cde520 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.history/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.jobs/index.html b/versions/readline-move/docs/api/hilbish/hilbish.jobs/index.html index 61f21650..cb46ed5d 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.jobs/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.messages/index.html b/versions/readline-move/docs/api/hilbish/hilbish.messages/index.html new file mode 100644 index 00000000..e095546d --- /dev/null +++ b/versions/readline-move/docs/api/hilbish/hilbish.messages/index.html @@ -0,0 +1,28 @@ +Module hilbish.messages — Hilbish +

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: +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.

Functions +

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 +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number

hilbish.messages.read(idx) +

Marks a message at idx as read.

Parameters +

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/readline-move/docs/api/hilbish/hilbish.module/index.html b/versions/readline-move/docs/api/hilbish/hilbish.module/index.html index f2286764..e8ac42a6 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.module/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.os/index.html b/versions/readline-move/docs/api/hilbish/hilbish.os/index.html index c94d12c7..db7fad29 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.os/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.processors/index.html b/versions/readline-move/docs/api/hilbish/hilbish.processors/index.html new file mode 100644 index 00000000..3bfa8a2d --- /dev/null +++ b/versions/readline-move/docs/api/hilbish/hilbish.processors/index.html @@ -0,0 +1,10 @@ +Module hilbish.processors — Hilbish +

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. +It returns the processed command (which may be the same as the passed command) +and a boolean which states whether to proceed with command execution.

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/readline-move/docs/api/hilbish/hilbish.runner/index.html b/versions/readline-move/docs/api/hilbish/hilbish.runner/index.html index 5888abaa..b797f756 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.runner/index.html +++ b/versions/readline-move/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,6 +28,34 @@ shell script if fennel eval has an error.

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

Functions -

lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile

hilbish.runner.lua(cmd) +

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

Want to help improve this page? Create an issue.

\ No newline at end of file +

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.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.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/readline-move/docs/api/hilbish/hilbish.timers/index.html b/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html index 460dc97b..6ded1d48 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/hilbish.userdir/index.html b/versions/readline-move/docs/api/hilbish/hilbish.userdir/index.html index f89cca5f..fc8a86b3 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.userdir/index.html +++ b/versions/readline-move/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/readline-move/docs/api/hilbish/index.html b/versions/readline-move/docs/api/hilbish/index.html index 73259c47..706880ea 100644 --- a/versions/readline-move/docs/api/hilbish/index.html +++ b/versions/readline-move/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.
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 @@ -121,4 +121,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/readline-move/docs/api/hilbish/index.xml b/versions/readline-move/docs/api/hilbish/index.xml index 6784475b..702513ad 100644 --- a/versions/readline-move/docs/api/hilbish/index.xml +++ b/versions/readline-move/docs/api/hilbish/index.xml @@ -1,12 +1,14 @@ -Module hilbish on Hilbishhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/Recent content in Module hilbish on HilbishHugo -- gohugo.ioen-usModule hilbish.aliaseshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/Introduction The alias interface deals with all command aliases in Hilbish. +Module hilbish on Hilbishhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/Recent content in Module hilbish on HilbishHugo -- gohugo.ioen-usModule hilbish.abbrhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/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.Module hilbish.aliaseshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/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) This is an alias (ha) for the hilbish.Module hilbish.completionhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/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.Module hilbish.editorhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/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() -> string Returns the current input line. getVimRegister(register) -> string Returns the text that is at the register. insert(text) Inserts text into the Hilbish command line. getChar() -> string Reads a keystroke from the user. This is in a format of something like Ctrl-L.Module hilbish.historyhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.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 add(cmd) Adds a command to the history. all() -> 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() -> number Returns the amount of commands in the history. hilbish.Module hilbish.jobshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/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.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/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. +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.Module hilbish.messageshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/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.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/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. Note that you don’t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.Module hilbish.oshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.os/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.os/ Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version. -Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OSModule hilbish.runnerhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/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 language or script of their choosing. A good example is using it to write command in Fennel. +Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OSModule hilbish.processorshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.processors/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.processors/hilbish.processors.add() Parameters This function has no parameters. +hilbish.processors.execute() Run all command processors, in order by priority. It returns the processed command (which may be the same as the passed command) and a boolean which states whether to proceed with command execution. +Parameters This function has no parameters.Module hilbish.runnerhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/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 language or script of their choosing. A good example is using it to write command in Fennel. Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code. A runner is passed the input and has to return a table with these values.Module hilbish.timershttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.timers/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.timers/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 accessible with doc hilbish, or Module hilbish on the Website). diff --git a/versions/readline-move/docs/api/index.html b/versions/readline-move/docs/api/index.html index 09dcaf83..12b343fd 100644 --- a/versions/readline-move/docs/api/index.html +++ b/versions/readline-move/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/readline-move/docs/api/readline/index.html b/versions/readline-move/docs/api/readline/index.html index f4a00a5a..a8e302c1 100644 --- a/versions/readline-move/docs/api/readline/index.html +++ b/versions/readline-move/docs/api/readline/index.html @@ -1,7 +1,7 @@ Module readline — Hilbish

Module readline

Package readline is a pure-Go re-imagining of the UNIX readline API

Introduction +

Module readline

Package readline is a pure-Go re-imagining of the UNIX readline API

Introduction

This package is designed to be run independently from murex and at some point it will be separated into it’s own git repository (at a stage when I am confident that murex will no longer be the primary driver for features, diff --git a/versions/readline-move/docs/api/snail/index.html b/versions/readline-move/docs/api/snail/index.html index 0e2992d2..2508b44c 100644 --- a/versions/readline-move/docs/api/snail/index.html +++ b/versions/readline-move/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/versions/readline-move/docs/api/terminal/index.html b/versions/readline-move/docs/api/terminal/index.html index 0f058e0f..a249110c 100644 --- a/versions/readline-move/docs/api/terminal/index.html +++ b/versions/readline-move/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/readline-move/docs/completions/index.html b/versions/readline-move/docs/completions/index.html index 6c73c3be..95928149 100644 --- a/versions/readline-move/docs/completions/index.html +++ b/versions/readline-move/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: