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/readline-move/docs/api/commander/index.html b/versions/readline-move/docs/api/commander/index.html
index e90b1327..6a7825f5 100644
--- a/versions/readline-move/docs/api/commander/index.html
+++ b/versions/readline-move/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/readline-move/docs/api/fs/index.html b/versions/readline-move/docs/api/fs/index.html index 0b88808a..dba2fae2 100644 --- a/versions/readline-move/docs/api/fs/index.html +++ b/versions/readline-move/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
The hilbish.editor interface provides functions to +directly interact with the line editor in use.
| 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. |
| setVimRegister(register, text) | Sets the vim register at register to hold the passed text. |
Deletes characters in the line by the given amount.
number amount
Returns the current input line.
This function has no parameters.
Returns the text that is at the register.
string register
Reads a keystroke from the user. This is in a format of something like Ctrl-L.
This function has no parameters.
command history
The history interface deals with command history. +This includes the ability to override functions to change the main +method of saving history.
| 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. |
Retrieves all history as a table.
This function has no parameters.
Deletes all commands from the history.
This function has no parameters.
Retrieves a command from the history based on the index.
number index
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. |
Creates a new job. This function does not run the job. This function is intended to be
used by runners, but can also be used to create jobs via Lua. Commanders cannot be ran as jobs.
string cmdstr
String that a user would write for the job
table args
Arguments for the commands. Has to include the name of the command.
string execPath
Binary to use to run the command. Needs to be an absolute path.
1hilbish.jobs.add('go build', {'go', 'build'}, '/usr/bin/go')
+Returns a table of all job objects.
This function has no parameters.
Disowns a job. This simply deletes it from the list of jobs without stopping it.
number id
Get a job object via its ID.
This function has no parameters.
Returns the last added job to the table.
This function has no parameters.
The Job type describes a Hilbish job.
| cmd | The user entered command string for the job. |
| running | Whether the job is running or not. |
| id | The ID of the job in the job table |
| pid | The Process ID |
| exitCode | The last exit code of the job. |
| stdout | The standard output of the job. This just means the normal logs of the process. |
| stderr | The standard error stream of the process. This (usually) includes error messages of the job. |
Puts a job in the background. This acts the same as initially running a job.
Puts a job in the foreground. This will cause it to run like it was +executed normally and wait for it to complete.
Starts running the job.
Stops the job from running.
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 +) 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.
To make a valid native module, the Go plugin has to export a Loader function
+with a signature like so: func(*rt.Runtime) rt.Value.
rt in this case refers to the Runtime type at
+https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime
Hilbish uses this package as its Lua runtime. You will need to read +it to use it for a native plugin.
Here is some code for an example plugin:
1package main
+2
+3import (
+4 rt "github.com/arnodel/golua/runtime"
+5)
+6
+7func Loader(rtm *rt.Runtime) rt.Value {
+8 return rt.StringValue("hello world!")
+9}
+This can be compiled with go build -buildmode=plugin plugin.go.
+If you attempt to require and print the result (print(require 'plugin')), it will show “hello world!”
| load(path) | Loads a module at the designated path. |
| paths | A list of paths to search when loading native modules. This is in the style of Lua search paths and will be used when requiring native modules. Example: ?.so;?/?.so |
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/readline-move/docs/api/hilbish/hilbish.timers/index.html b/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html new file mode 100644 index 00000000..460dc97b --- /dev/null +++ b/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html @@ -0,0 +1,26 @@ +
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
+accessible with doc hilbish, or Module hilbish on the Website).
An example of usage:
1local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function()
+2 print 'hello!'
+3end)
+4
+5t:start()
+6print(t.running) // true
+| create(type, time, callback) -> @Timer | Creates a timer that runs based on the specified time. |
| get(id) -> @Timer | Retrieves a timer via its ID. |
| INTERVAL | Constant for an interval timer type |
| TIMEOUT | Constant for a timeout timer type |
Creates a timer that runs based on the specified time.
number type
What kind of timer to create, can either be hilbish.timers.INTERVAL or hilbish.timers.TIMEOUT
number time
The amount of time the function should run in milliseconds.
function callback
The function to run for the timer.
The Job type describes a Hilbish timer.
| type | What type of timer it is |
| running | If the timer is running |
| duration | The duration in milliseconds that the timer will run |
Starts a timer.
Stops a timer.
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. |
string line
1--This code will highlight all double quoted strings in green.
2function hilbish.highlighter(line)
-3 return line:gsub('"%w+"', function(c) return lunacolors.green(c) end)
-4end
+3
+4 return line:gsub('"%w+"', function(c) return lunacolors.green(c) end)
+5
+6end
The command line hint handler. It gets called on every key insert to
determine what text to use as an inline hint. It is passed the current
line and cursor position. It is expected to return a string which is used
as the text for the hint. This is by default a shim. To set hints,
override this function with your custom handler.
string line
number pos
Position of cursor in line. Usually equals string.len(line)
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.
Package readline is a pure-Go re-imagining of the UNIX readline API
Package readline is a pure-Go re-imagining of the UNIX readline API
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, -bugs or other code changes)
Package terminal provides support functions for dealing with terminals, as +bugs or other code changes)
line reader library
+The readline module is responsible for reading input from the user.
+The readline module is what Hilbish uses to read input from the user,
+including all the interactive features of Hilbish like history search,
+syntax highlighting, everything. The global Hilbish readline instance
+is usable at hilbish.editor.
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
Putting a terminal into raw mode is the most common requirement:
oldState, err := terminal.MakeRaw(0)
if err != nil {
panic(err)
diff --git a/versions/readline-move/docs/api/snail/index.html b/versions/readline-move/docs/api/snail/index.html
index c89ee6c6..0e2992d2 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 c063dc1c..0f058e0f 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 ca01d5b6..6c73c3be 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:
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/readline-move/docs/faq/index.html b/versions/readline-move/docs/faq/index.html
index 148a910f..0c1f39bd 100644
--- a/versions/readline-move/docs/faq/index.html
+++ b/versions/readline-move/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>
Frequently Asked Questions
Last updated Dec 26, 2023
Is Hilbish POSIX compliant?
+
Frequently Asked Questions
Last updated Dec 26, 2023
Is Hilbish POSIX compliant?
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 ….)
Windows Support?
diff --git a/versions/readline-move/docs/features/index.html b/versions/readline-move/docs/features/index.html
index 5c591579..a5d3e168 100644
--- a/versions/readline-move/docs/features/index.html
+++ b/versions/readline-move/docs/features/index.html
@@ -1,7 +1,7 @@
Features — Hilbish
Features
Last updated Dec 26, 2023
Hilbish has a wide range of features to enhance the user’s experience
+
Features
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.
Notification — Hilbish
Notification
Last updated Dec 26, 2023
Get notified of shell actions.
Hilbish features a simple notification system which can be
+
Notification
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/readline-move/docs/features/opts/index.html b/versions/readline-move/docs/features/opts/index.html
index fb11acf3..9c6104ee 100644
--- a/versions/readline-move/docs/features/opts/index.html
+++ b/versions/readline-move/docs/features/opts/index.html
@@ -1,7 +1,7 @@
Options — Hilbish
Options
Simple customizable options.
Opts are simple toggle or value options a user can set in Hilbish.
+
Options
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/readline-move/docs/features/runner-mode/index.html b/versions/readline-move/docs/features/runner-mode/index.html
index 454f4d7b..b6a33031 100644
--- a/versions/readline-move/docs/features/runner-mode/index.html
+++ b/versions/readline-move/docs/features/runner-mode/index.html
@@ -1,7 +1,7 @@
Runner Mode — Hilbish
Runner Mode
Last updated Dec 26, 2023
Customize the interactive script/command runner.
Hilbish allows you to change how interactive text can be interpreted.
+
Runner Mode
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/readline-move/docs/getting-started/index.html b/versions/readline-move/docs/getting-started/index.html
index 5ec7121c..77b38650 100644
--- a/versions/readline-move/docs/getting-started/index.html
+++ b/versions/readline-move/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>
Getting Started
Last updated Dec 26, 2023
To start Hilbish, open a terminal. If Hilbish has been installed and is not the
+
Getting Started
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.
Setting as Default
diff --git a/versions/readline-move/docs/hooks/command/index.html b/versions/readline-move/docs/hooks/command/index.html
index be7e7ee1..d1336e20 100644
--- a/versions/readline-move/docs/hooks/command/index.html
+++ b/versions/readline-move/docs/hooks/command/index.html
@@ -19,7 +19,7 @@ string cmdStr
The command or code that was executed" name=description>
Command
command.preexec
+
Command
command.preexec
Thrown right before a command is executed.
Variables
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/readline-move/docs/hooks/hilbish/index.html b/versions/readline-move/docs/hooks/hilbish/index.html
index 590882cd..436fb7e3 100644
--- a/versions/readline-move/docs/hooks/hilbish/index.html
+++ b/versions/readline-move/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>
Hilbish
hilbish.exit
+
Hilbish
hilbish.exit
Sent when Hilbish is going to exit.
Variables
This signal returns no variables.
hilbish.vimMode
Sent when the Vim mode of Hilbish is changed (like from insert to normal mode).
diff --git a/versions/readline-move/docs/hooks/index.html b/versions/readline-move/docs/hooks/index.html
index 0cdcf11d..d72e7ca4 100644
--- a/versions/readline-move/docs/hooks/index.html
+++ b/versions/readline-move/docs/hooks/index.html
@@ -1,6 +1,6 @@
Signals — Hilbish
Signals
Signals are global events emitted with the Bait
module.
For more detail on how to use these signals, you may check the Bait page.
Signal
signal.sigint
+
Signal
signal.sigint
Thrown when Hilbish receive the SIGINT signal,
aka when Ctrl-C is pressed.
Variables
This signal returns no variables.
signal.resize
diff --git a/versions/readline-move/docs/index.html b/versions/readline-move/docs/index.html
index dc9eb685..b6de81e0 100644
--- a/versions/readline-move/docs/index.html
+++ b/versions/readline-move/docs/index.html
@@ -3,7 +3,7 @@ Here documents some of the features of Hilbish and the Lua API." property="og:de
Here documents some of the features of Hilbish and the Lua API." name=description>
Introduction
Last updated Dec 26, 2023
Hilbish is a hyper-extensible shell mainly intended for interactive use.
+
Introduction
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
Lunacolors is an ANSI color/styling library for Lua. It is included
+
Lunacolors
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/readline-move/docs/nature/dirs/index.html b/versions/readline-move/docs/nature/dirs/index.html
index 54beb3d0..69de1f7a 100644
--- a/versions/readline-move/docs/nature/dirs/index.html
+++ b/versions/readline-move/docs/nature/dirs/index.html
@@ -1,7 +1,7 @@
Module dirs — Hilbish
Module dirs
internal directory management
Introduction
+
Module dirs
internal directory management
Introduction
The dirs module defines a small set of functions to store and manage
directories.
Functions
setOld(d) Sets the old directory string. recent(idx) Get entry from recent directories list based on index. push(dir) Add dir to the recent directories list. 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.
dirs.peak(num)
diff --git a/versions/readline-move/docs/nature/doc/index.html b/versions/readline-move/docs/nature/doc/index.html
index 7fd6125e..ca17825a 100644
--- a/versions/readline-move/docs/nature/doc/index.html
+++ b/versions/readline-move/docs/nature/doc/index.html
@@ -1,7 +1,7 @@
Module doc — Hilbish
Module doc
command-line doc rendering
Introduction
+
Module doc
command-line doc rendering
Introduction
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/readline-move/docs/nature/index.html b/versions/readline-move/docs/nature/index.html
index ea98d6d1..cc2af22e 100644
--- a/versions/readline-move/docs/nature/index.html
+++ b/versions/readline-move/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>
Nature
A bit after creation, we have the outside nature. Little plants, seeds,
+
Nature
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/readline-move/docs/vim-mode/actions/index.html b/versions/readline-move/docs/vim-mode/actions/index.html
index 60a670d7..f2773500 100644
--- a/versions/readline-move/docs/vim-mode/actions/index.html
+++ b/versions/readline-move/docs/vim-mode/actions/index.html
@@ -5,7 +5,7 @@ The hilbish.vimAction hook is thrown whenever a Vim action occurs. It passes 2 a
Here is documentation for what the table of args will hold for an appropriate Vim action." name=description>
Actions
Vim actions are essentially just when a user uses a Vim keybind.
+
Actions
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/readline-move/docs/vim-mode/index.html b/versions/readline-move/docs/vim-mode/index.html
index 29e1e040..7daa3262 100644
--- a/versions/readline-move/docs/vim-mode/index.html
+++ b/versions/readline-move/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>
Vim Mode
Hilbish has a Vim binding input mode accessible for use.
+
Vim Mode
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.
Module fs https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000 https://rosettea.github.io/Hilbish/versions/readline-move/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 hilbish.aliases https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/Mon, 01 Jan 0001 00:00:00 +0000 https://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.completion https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/Mon, 01 Jan 0001 00:00:00 +0000 https://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.runner https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/Mon, 01 Jan 0001 00:00:00 +0000 https://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.
+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.editor https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/Mon, 01 Jan 0001 00:00:00 +0000 https://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.history https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/Mon, 01 Jan 0001 00:00:00 +0000 https://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.jobs https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/Mon, 01 Jan 0001 00:00:00 +0000 https://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.module https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000 https://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.os https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.os/Mon, 01 Jan 0001 00:00:00 +0000 https://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 OS Module hilbish.runner https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/Mon, 01 Jan 0001 00:00:00 +0000 https://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.userDir https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/Mon, 01 Jan 0001 00:00:00 +0000 https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ 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.
+A runner is passed the input and has to return a table with these values. Module hilbish.timers https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.timers/Mon, 01 Jan 0001 00:00:00 +0000 https://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).
+An example of usage:
+1local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function() 2 print 'hello! Module hilbish.userDir https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/Mon, 01 Jan 0001 00:00:00 +0000 https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ 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 config The user’s config directory data The user’s directory for program data Module readline https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/Mon, 01 Jan 0001 00:00:00 +0000 https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/ 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, bugs or other code changes)
-Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
-Putting a terminal into raw mode is the most common requirement: Module snail https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000 https://rosettea.github.io/Hilbish/versions/readline-move/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.
+line reader library The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything. Module snail https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000 https://rosettea.github.io/Hilbish/versions/readline-move/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.
diff --git a/versions/readline-move/sitemap.xml b/versions/readline-move/sitemap.xml
index 28002827..8f643ddc 100644
--- a/versions/readline-move/sitemap.xml
+++ b/versions/readline-move/sitemap.xml
@@ -1 +1 @@
-https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/actions/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/lunacolors/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/faq/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/getting-started/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/ 2024-07-20T10:14:16-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/ 2024-07-20T10:14:16-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/ 2023-12-26T00:13:50-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/ 2023-04-14T00:04:52-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/ 2023-04-10T12:38:30-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/ 2023-04-01T18:16:13-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/ 2023-02-10T17:11:44-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/ 2022-12-28T22:27:05-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/ 2023-12-26T00:13:35-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/job/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/jobs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/timers/ https://rosettea.github.io/Hilbish/versions/readline-move/categories/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/command/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/completions/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/hilbish/ https://rosettea.github.io/Hilbish/versions/readline-move/install/ 2023-04-14T00:04:52-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/dirs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/doc/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/terminal/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/notifications/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/opts/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/runner-mode/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/signal/ https://rosettea.github.io/Hilbish/versions/readline-move/tags/ https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/ 2022-12-28T22:27:05-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/actions/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/lunacolors/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/faq/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/getting-started/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/ 2024-07-20T10:14:16-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/ 2024-07-20T10:14:16-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/ 2023-12-26T00:13:50-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/ 2023-04-14T00:04:52-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/ 2023-04-10T12:38:30-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/ 2023-04-01T18:16:13-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/ 2023-02-10T17:11:44-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/ 2022-12-28T22:27:05-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/ 2023-12-26T00:13:35-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/job/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/jobs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/timers/ https://rosettea.github.io/Hilbish/versions/readline-move/categories/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/command/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/completions/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/hilbish/ https://rosettea.github.io/Hilbish/versions/readline-move/install/ 2023-04-14T00:04:52-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/dirs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/doc/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.os/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.timers/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/terminal/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/notifications/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/opts/ https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/runner-mode/ 2023-12-25T23:08:29-04:00 https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/signal/ https://rosettea.github.io/Hilbish/versions/readline-move/tags/ https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/ 2022-12-28T22:27:05-04:00