the event emitter
the event emitter
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/snail/docs/api/commander/index.html b/versions/snail/docs/api/commander/index.html
index 829956d..6b630f4 100644
--- a/versions/snail/docs/api/commander/index.html
+++ b/versions/snail/docs/api/commander/index.html
@@ -1,7 +1,7 @@
library for custom commands
library for custom commands
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/snail/docs/api/fs/index.html b/versions/snail/docs/api/fs/index.html index 01e36c0..7cb34cd 100644 --- a/versions/snail/docs/api/fs/index.html +++ b/versions/snail/docs/api/fs/index.html @@ -1,7 +1,7 @@
filesystem interaction and functionality library
filesystem interaction and functionality library
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.
command aliasing
command aliasing
The alias interface deals with all command aliases in Hilbish.
| 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. |
tab completions
tab completions
The completions interface deals with tab completions.
| 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 |
Return binaries/executables based on the provided parameters.
This function is meant to be used as a helper in a command completion handler.
interactions for Hilbish's line reader
interactions for Hilbish's line reader
The hilbish.editor interface provides functions to directly interact with the line editor in use.
| 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. |
| setVimRegister(register, text) | Sets the vim register at register to hold the passed text. |
command history
command history
The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
background job management
background job management
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.
| 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) -> @Job | Get a job object via its ID. |
| last() -> @Job | Returns the last added job to the table. |
simplistic message passing
simplistic message passing
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/versions/snail/docs/api/hilbish/hilbish.module/index.html b/versions/snail/docs/api/hilbish/hilbish.module/index.html
index ef84dd5..58eabf4 100644
--- a/versions/snail/docs/api/hilbish/hilbish.module/index.html
+++ b/versions/snail/docs/api/hilbish/hilbish.module/index.html
@@ -1,7 +1,7 @@
native module loading
native module loading
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/snail/docs/api/hilbish/hilbish.os/index.html b/versions/snail/docs/api/hilbish/hilbish.os/index.html index 69cf81b..005eb54 100644 --- a/versions/snail/docs/api/hilbish/hilbish.os/index.html +++ b/versions/snail/docs/api/hilbish/hilbish.os/index.html @@ -1,7 +1,7 @@
operating system info
interactive command runner customization
interactive command runner customization
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,28 +28,34 @@ shell script if fennel eval has an error.
11 return hilbish.runner.sh(input)
12end)
| lua(cmd) | Evaluates cmd as Lua input. This is the same as using dofile |
| 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. |
| run(input, priv) | Runs input with the currently set Hilbish runner. |
| sh() | nil |
| lua(cmd) | Evaluates cmd as Lua input. This is the same as using dofile |
| exec(cmd, runnerName) | Executes cmd with a runner. |
| run(input, priv) | Runs input with the currently set Hilbish runner. |
| getCurrent() | Returns the current runner by name. |
| setCurrent(name) | Sets Hilbish’s runner mode by name. |
| setMode(mode) | NOTE: This function is deprecated and will be removed in 3.0 |
| sh() | nil |
| add(name, runner) | Adds a runner to the table of available runners. |
| set(name, runner) | Sets a runner by name. The difference between this function and |
| get(name) | Get a runner by name. |
Evaluates cmd as Lua input. This is the same as using dofile
or load, but is appropriated for the runner interface.
string cmd
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.
input string
priv bool
Returns the current runner by name.
This function has no parameters.
Adds a runner to the table of available runners. -If runner is a table, it must have the run function in it.
name string
Name of the runner
runner function|table
Get a runner by name.
name string
Name of the runner to retrieve.
Get a runner by name.
name string
Name of the runner to retrieve.
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.
name string
runner table
name string
runner table
Adds a runner to the table of available runners. +If runner is a table, it must have the run function in it.
name string
Name of the runner
runner function|table
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.
mode string|function
Returns the current runner by name.
This function has no parameters.
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.
input string
priv bool
runnerName is not specified, it uses the default Hilbish runner.cmd string
runnerName string?
timeout and interval API
timeout and interval API
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/snail/docs/api/hilbish/hilbish.userdir/index.html b/versions/snail/docs/api/hilbish/hilbish.userdir/index.html
index 9eb6993..0b7c170 100644
--- a/versions/snail/docs/api/hilbish/hilbish.userdir/index.html
+++ b/versions/snail/docs/api/hilbish/hilbish.userdir/index.html
@@ -1,7 +1,7 @@
user-related directories
user-related directories
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.
the core Hilbish API
the core Hilbish API
The Hilbish module includes the core API, containing interfaces and functions which directly relate to shell functionality.
| 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() -> string | Returns 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) -> @Timer | Runs 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) -> @Timer | Executed the cb function after a period of time. |
| which(name) -> string | Checks if name is a valid command. |
| 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() -> string | Returns 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) -> @Timer | Runs 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) -> @Timer | Executed the cb function after a period of time. |
| which(name) -> string | Checks if name is a valid command. |
| runnerMode(mode) | Sets the execution/runner mode for interactive Hilbish. |
| ver | The version of Hilbish |
| goVersion | The version of Go that Hilbish was compiled with |
| user | Username of the user |
| host | Hostname of the machine |
| dataDir | Directory for Hilbish data files, including the docs and default modules |
| interactive | Is Hilbish in an interactive shell? |
| login | Is Hilbish the login shell? |
| vimMode | Current Vim input mode of Hilbish (will be nil if not in Vim input mode) |
| exitCode | Exit code of the last executed command |
Sets an alias, with a name of cmd to another command.
string cmd
Name of the alias
string orig
Command that will be aliased
Executed the cb function after a period of time.
This creates a Timer that starts ticking immediately.
function cb
number time
Time to run in milliseconds.
string name
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.
mode string|function
Welcome to the API documentation for Hilbish. This documents Lua functions +
Welcome to the API documentation for Hilbish. This documents Lua functions provided by Hilbish.
shell script interpreter library
shell script interpreter library
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.
low level terminal library
low level terminal library
The terminal library is a simple and lower level library for certain terminal interactions.
| 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 |
Restores the last saved state of the terminal
Tab completion for commands.
Completions for commands can be created with the hilbish.complete
+
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:
query (string): The text that the user is currently trying to complete.
This should be used to match entries.ctx (string): Contains the entire line. Use this if
diff --git a/versions/snail/docs/faq/index.html b/versions/snail/docs/faq/index.html
index d0b6860..5022cd4 100644
--- a/versions/snail/docs/faq/index.html
+++ b/versions/snail/docs/faq/index.html
@@ -5,7 +5,7 @@ Windows Support? It compiles for Windows (CI ensures it does), but otherwise it
Why? Hilbish emerged from the desire of a Lua configured shell." name=description>
Last updated Dec 26, 2023
Last updated Dec 26, 2023
No, it is not. POSIX compliance is a non-goal. Perhaps in the future, someone would be able to write a native plugin to support shell scripting (which would be against it’s main goal, but ….)
Last updated Dec 26, 2023
Hilbish has a wide range of features to enhance the user’s experience +
Last updated Dec 26, 2023
Hilbish has a wide range of features to enhance the user’s experience new ones are always being added. If there is something missing here or something you would like to see, please start a discussion or comment on any existing ones which match your request.
Last updated Dec 26, 2023
Get notified of shell actions.
Hilbish features a simple notification system which can be +
Last updated Dec 26, 2023
Get notified of shell actions.
Hilbish features a simple notification system which can be
used by other plugins and parts of the shell to notify the user
of various actions. This is used via the hilbish.message interface.
A message is defined as a table with the following properties:
icon: A unicode/emoji icon for the notification.title: The title of the messagetext: Message text/bodychannel: The source of the message. This should be a
unique and easily readable text identifier.summary: A short summary of the notification and message.
diff --git a/versions/snail/docs/features/opts/index.html b/versions/snail/docs/features/opts/index.html
index 9647eb3..3be82f9 100644
--- a/versions/snail/docs/features/opts/index.html
+++ b/versions/snail/docs/features/opts/index.html
@@ -1,7 +1,7 @@
Simple customizable options.
Opts are simple toggle or value options a user can set in Hilbish. +
Simple customizable options.
Opts are simple toggle or value options a user can set in Hilbish.
As toggles, there are things like autocd or history saving. As values,
there is the motd which the user can either change to a custom string or disable.
Opts are accessed from the hilbish.opts table. Here they can either
be read or modified
autocd
diff --git a/versions/snail/docs/features/runner-mode/index.html b/versions/snail/docs/features/runner-mode/index.html
index e5f7aa3..0d79340 100644
--- a/versions/snail/docs/features/runner-mode/index.html
+++ b/versions/snail/docs/features/runner-mode/index.html
@@ -1,7 +1,7 @@
Last updated Dec 26, 2023
Customize the interactive script/command runner.
Hilbish allows you to change how interactive text can be interpreted. +
Last updated Dec 26, 2023
Customize the interactive script/command runner.
Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.
In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use diff --git a/versions/snail/docs/getting-started/index.html b/versions/snail/docs/getting-started/index.html index 6f0606f..e489b98 100644 --- a/versions/snail/docs/getting-started/index.html +++ b/versions/snail/docs/getting-started/index.html @@ -3,7 +3,7 @@ Setting as Default Login shell There are a few ways to make Hilbish your default Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell." name=description>
Last updated Dec 26, 2023
To start Hilbish, open a terminal. If Hilbish has been installed and is not the +
Last updated Dec 26, 2023
To start Hilbish, open a terminal. If Hilbish has been installed and is not the
default shell, you can simply run hilbish to start it. This will launch
a normal interactive session.
To exit, you can either run the exit command or hit Ctrl+D.
Thrown right before a command is executed.
string input
The raw string that the user typed. This will include the text
without changes applied to it (argument substitution, alias expansion,
diff --git a/versions/snail/docs/hooks/hilbish/index.html b/versions/snail/docs/hooks/hilbish/index.html
index 71036dd..155b111 100644
--- a/versions/snail/docs/hooks/hilbish/index.html
+++ b/versions/snail/docs/hooks/hilbish/index.html
@@ -11,7 +11,7 @@ The mode that has been set. Can be these values: insert, normal, delete or repla
hilbish.cancel Sent when the user cancels their command input with Ctrl-C" name=description>
Sent when Hilbish is going to exit.
This signal returns no variables.
Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). diff --git a/versions/snail/docs/hooks/index.html b/versions/snail/docs/hooks/index.html index f853f6b..c48c4be 100644 --- a/versions/snail/docs/hooks/index.html +++ b/versions/snail/docs/hooks/index.html @@ -1,6 +1,6 @@
Signals are global events emitted with the Bait module. For more detail on how to use these signals, you may check the Bait page.
Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
This signal returns no variables.
Last updated Dec 26, 2023
Hilbish is a hyper-extensible shell mainly intended for interactive use. +
Last updated Dec 26, 2023
Hilbish is a hyper-extensible shell mainly intended for interactive use. To enhance the interactive experience, Hilbish comes with a wide range of features and sane defaults, including a nice looking prompt, advanced completion menus and history search.
Here documents some of the features of Hilbish and the Lua API.
Lunacolors is an ANSI color/styling library for Lua. It is included +
Lunacolors is an ANSI color/styling library for Lua. It is included by default in standard Hilbish distributions to provide easy styling for things like prompts and text.
For simple usage, a single color or style is enough. For example,
you can just use lunacolors.blue 'Hello world' and that’ll return
diff --git a/versions/snail/docs/nature/dirs/index.html b/versions/snail/docs/nature/dirs/index.html
index fe5d551..6a9982e 100644
--- a/versions/snail/docs/nature/dirs/index.html
+++ b/versions/snail/docs/nature/dirs/index.html
@@ -1,7 +1,7 @@
internal directory management
internal directory management
The dirs module defines a small set of functions to store and manage directories.
| recent(idx) | Get entry from recent directories list based on index. |
| pop(num) | Remove the specified amount of dirs from the recent directories list. |
| peak(num) | Look at num amount of recent directories, starting from the latest. |
| push(dir) | Add dir to the recent directories list. |
| setOld(d) | Sets the old directory string. |
command-line doc rendering
command-line doc rendering
The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It’s only intended use diff --git a/versions/snail/docs/nature/index.html b/versions/snail/docs/nature/index.html index a2836a3..9722774 100644 --- a/versions/snail/docs/nature/index.html +++ b/versions/snail/docs/nature/index.html @@ -5,7 +5,7 @@ Hilbish’s Lua core module is called nature. It runs after Hilbish’s Nature Modules Currently, nature provides 1 intended public module: nature.dirs. It is a simple API for managing recent directories and old current working directory." name=description>
A bit after creation, we have the outside nature. Little plants, seeds, +
A bit after creation, we have the outside nature. Little plants, seeds,
growing to their final phase: a full plant. A lot of Hilbish itself is
written in Go, but there are parts made in Lua, being most builtins
(doc, cd, cdr), completions, and other things.
Hilbish’s Lua core module is called nature.
diff --git a/versions/snail/docs/nature/index.xml b/versions/snail/docs/nature/index.xml
index f63cab5..a4bddce 100644
--- a/versions/snail/docs/nature/index.xml
+++ b/versions/snail/docs/nature/index.xml
@@ -1,5 +1,3 @@
Vim actions are essentially just when a user uses a Vim keybind. +
Vim actions are essentially just when a user uses a Vim keybind. Things like yanking and pasting are Vim actions. This is not an “offical Vim thing,” just a Hilbish thing.
The hilbish.vimAction hook is thrown whenever a Vim action occurs.
It passes 2 arguments: the action name, and an array (table) of args
diff --git a/versions/snail/docs/vim-mode/index.html b/versions/snail/docs/vim-mode/index.html
index 76113ea..6240d38 100644
--- a/versions/snail/docs/vim-mode/index.html
+++ b/versions/snail/docs/vim-mode/index.html
@@ -3,5 +3,5 @@ This is documentation for everything relating to it." property="og:description">
This is documentation for everything relating to it." name=description>
Hilbish has a Vim binding input mode accessible for use. +
Hilbish has a Vim binding input mode accessible for use.
It can be enabled with the hilbish.inputMode function (check doc hilbish).
This is documentation for everything relating to it.