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/doc-improvements/docs/api/commander/index.html b/versions/doc-improvements/docs/api/commander/index.html
index 7347082..5cf741a 100644
--- a/versions/doc-improvements/docs/api/commander/index.html
+++ b/versions/doc-improvements/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/doc-improvements/docs/api/fs/index.html b/versions/doc-improvements/docs/api/fs/index.html index 81dfa94..bb24cdf 100644 --- a/versions/doc-improvements/docs/api/fs/index.html +++ b/versions/doc-improvements/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. |
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/doc-improvements/docs/api/hilbish/hilbish.os/index.html b/versions/doc-improvements/docs/api/hilbish/hilbish.os/index.html index 6579e46..1404346 100644 --- a/versions/doc-improvements/docs/api/hilbish/hilbish.os/index.html +++ b/versions/doc-improvements/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 diff --git a/versions/doc-improvements/docs/api/hilbish/hilbish.timers/index.html b/versions/doc-improvements/docs/api/hilbish/hilbish.timers/index.html index 27697a1..54279f4 100644 --- a/versions/doc-improvements/docs/api/hilbish/hilbish.timers/index.html +++ b/versions/doc-improvements/docs/api/hilbish/hilbish.timers/index.html @@ -1,7 +1,7 @@
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/doc-improvements/docs/api/hilbish/hilbish.userdir/index.html b/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/index.html
index d009cd5..b85822c 100644
--- a/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/index.html
+++ b/versions/doc-improvements/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. Accepts either emacs or vim. |
| interval(cb, time) -> @Timer | Runs the cb function every time milliseconds. |
| 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, returnOut) -> exitCode (number), stdout (string), stderr (string) | Runs cmd in Hilbish’s shell script interpreter. |
| runnerMode(mode) | Sets the execution/runner mode for interactive Hilbish. This determines whether |
| timeout(cb, time) -> @Timer | Runs the cb function after time in milliseconds. |
| which(name) -> string | Checks if name is a valid command. |
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.
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.
Hilbish has a pretty good completion system. It has a nice looking +
Tab completion for commands.
Hilbish has a pretty good completion system. It has a nice looking menu, with 2 types of menus: grid (like file completions) or list.
Like most parts of Hilbish, it’s made to be extensible and customizable. The default handler for completions in general can diff --git a/versions/doc-improvements/docs/faq/index.html b/versions/doc-improvements/docs/faq/index.html index 42ca896..c065c36 100644 --- a/versions/doc-improvements/docs/faq/index.html +++ b/versions/doc-improvements/docs/faq/index.html @@ -5,7 +5,7 @@ Why? Hilbish emerged from the desire of a Lua configured shell." property="og:de Windows Support? It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you’d like to improve this situation, checkout the discussion . Why? Hilbish emerged from the desire of a Lua configured shell." name=description>
Last updated Nov 12, 2023
Last updated Nov 12, 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 Nov 12, 2023
Hilbish has a wide range of features to enhance the user’s experience +
Last updated Nov 12, 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 Nov 12, 2023
Get notified of shell actions.
Hilbish features a simple notification system which can be +
Last updated Nov 12, 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/doc-improvements/docs/features/runner-mode/index.html b/versions/doc-improvements/docs/features/runner-mode/index.html
index f7215c4..9c2ecb1 100644
--- a/versions/doc-improvements/docs/features/runner-mode/index.html
+++ b/versions/doc-improvements/docs/features/runner-mode/index.html
@@ -1,7 +1,7 @@
Last updated Nov 12, 2023
Customize the interactive script/command runner.
Hilbish allows you to change how interactive text can be interpreted. +
Last updated Nov 12, 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/doc-improvements/docs/getting-started/index.html b/versions/doc-improvements/docs/getting-started/index.html index 02e1fad..9c65406 100644 --- a/versions/doc-improvements/docs/getting-started/index.html +++ b/versions/doc-improvements/docs/getting-started/index.html @@ -3,7 +3,7 @@ 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." property="og:description">
Last updated Nov 12, 2023
To start Hilbish, open a terminal. If Hilbish has been installed and is not the +
Last updated Nov 12, 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.
command.preexec -> input, cmdStr > Thrown before a command
+
command.preexec -> input, cmdStr > Thrown before a command
is executed. The input is the user written command, while cmdStr
is what will be executed (input will have aliases while cmdStr
will have alias resolved input).
command.exit -> code, cmdStr > Thrown when a command exits.
diff --git a/versions/doc-improvements/docs/hooks/hilbish/index.html b/versions/doc-improvements/docs/hooks/hilbish/index.html
index 2e919cd..e7d2202 100644
--- a/versions/doc-improvements/docs/hooks/hilbish/index.html
+++ b/versions/doc-improvements/docs/hooks/hilbish/index.html
@@ -7,7 +7,7 @@ hilbish.vimMode -> modeName > Sent when Hilbish’s Vim mode is changed (exa
hilbish.vimAction -> actionName, args > Sent when the user does a “vim action,” being something like yanking or pasting text. See doc vim-mode actions for more info.
hilbish.cancel > Sent when the user cancels their input with Ctrl-C." name=description>
hilbish.exit > Sent when Hilbish is about to exit.
hilbish.vimMode -> modeName > Sent when Hilbish’s Vim mode is changed (example insert to normal mode),
+
hilbish.exit > Sent when Hilbish is about to exit.
hilbish.vimMode -> modeName > Sent when Hilbish’s Vim mode is changed (example insert to normal mode),
modeName is the name of the mode changed to (can be insert, normal, delete or replace).
hilbish.vimAction -> actionName, args > Sent when the user does a “vim action,” being something
like yanking or pasting text. See doc vim-mode actions for more info.
hilbish.cancel > Sent when the user cancels their input with Ctrl-C.
hilbish.notification -> message > Sent when a message is
sent.
signal.sigint > Sent when Hilbish receives SIGINT (on Ctrl-C).
signal.resize > Sent when the terminal is resized.
signal.sigusr1
signal.sigusr2
Last updated Nov 12, 2023
Hilbish is a hyper-extensible shell mainly intended for interactive use. +
Last updated Nov 12, 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.
Controls for background commands in Hilbish.
Hilbish has pretty standard job control. It’s missing one or two things, +
Controls for background commands in Hilbish.
Hilbish has pretty standard job control. It’s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it’s in Lua. You can add jobs, stop and delete (disown) them and even get output.
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/doc-improvements/docs/nature/index.html b/versions/doc-improvements/docs/nature/index.html
index 11db2b5..7fc7efd 100644
--- a/versions/doc-improvements/docs/nature/index.html
+++ b/versions/doc-improvements/docs/nature/index.html
@@ -1,13 +1,15 @@