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. |
| 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. |
| timeout(cb, time) -> @Timer | Executed the cb function after a period of time. |
| which(name) -> string | Checks if name is a valid command. |
| 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
1-- With this, "ga file" will turn into "git add file"
2hilbish.alias('ga', 'git add')
3
4-- Numbered substitutions are supported here!
5hilbish.alias('dircount', 'ls %1 | wc -l')
6-- "dircount ~" would count how many files are in ~ (home directory).
Appends the provided dir to the command path ($PATH)
string|table dir
Directory (or directories) to append to path
1hilbish.appendPath '~/go/bin'
2-- Will add ~/go/bin to the command path.
3
4-- Or do multiple:
5hilbish.appendPath {
6 '~/go/bin',
7 '~/.local/bin'
8}
Registers a completion handler for the specified scope.
A scope is expected to be command.<cmd>,
replacing command.git).
The documentation for completions, under Features/Completions or doc completions
provides more details.
string scope
function cb
1-- This is a very simple example. Read the full doc for completions for details.
2hilbish.complete('command.sudo', function(query, ctx, fields)
3 if #fields == 0 then
4 -- complete for commands
5 local comps, pfx = hilbish.completion.bins(query, ctx, fields)
6 local compGroup = {
7 items = comps, -- our list of items to complete
8 type = 'grid' -- what our completions will look like.
9 }
10
11 return {compGroup}, pfx
12 end
13
14 -- otherwise just be boring and return files
15
16 local comps, pfx = hilbish.completion.files(query, ctx, fields)
17 local compGroup = {
18 items = comps,
19 type = 'grid'
20 }
21
22 return {compGroup}, pfx
23end)
Returns the current directory of the shell.
This function has no parameters.
Replaces the currently running Hilbish instance with the supplied command.
This can be used to do an in-place restart.
string cmd
Puts fn in a Goroutine.
This can be used to run any function in another thread at the same time as other Lua code.
NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.
This is a limitation of the Lua runtime.
function fn
Line highlighter handler.
This is mainly for syntax highlighting, but in reality could set the input
of the prompt to display anything. The callback is passed the current line
and is expected to return a line that will be used as the input display.
Note that to set a highlighter, one has to override this function.
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
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)
1-- this will display "hi" after the cursor in a dimmed color.
2function hilbish.hinter(line, pos)
3 return 'hi'
4end
Sets the input mode for Hilbish’s line reader.emacs is the default. Setting it to vim changes behavior of input to be
Vim-like with modes and Vim keybinds.
string mode
Can be set to either emacs or vim
Runs the cb function every specified amount of time.
This creates a timer that ticking immediately.
function cb
number time
Time in milliseconds.
Changes the text prompt when Hilbish asks for more input.
This will show up when text is incomplete, like a missing quote
string str
1--[[
2imagine this is your text input:
3user ~ ∆ echo "hey
4
5but there's a missing quote! hilbish will now prompt you so the terminal
6will look like:
7user ~ ∆ echo "hey
8--> ...!"
9
10so then you get
11user ~ ∆ echo "hey
12--> ...!"
13hey ...!
14]]--
15hilbish.multiprompt '-->'
Changes the shell prompt to the provided string.
There are a few verbs that can be used in the prompt text.
These will be formatted and replaced with the appropriate values.%d - Current working directory%u - Name of current user%h - Hostname of device
string str
string typ?
Type of prompt, being left or right. Left by default.
1-- the default hilbish prompt without color
2hilbish.prompt '%u %d ∆'
3-- or something of old:
4hilbish.prompt '%u@%h :%d $'
5-- prompt: user@hostname: ~/directory $
Read input from the user, using Hilbish’s line editor/input reader.
This is a separate instance from the one Hilbish actually uses.
Returns input, will be nil if Ctrl-D is pressed, or an error occurs.
string prompt?
Text to print before input, can be empty.
Runs cmd in Hilbish’s shell script interpreter.
string cmd
boolean returnOut
If this is true, the function will return the standard output and error of the command instead of printing it.
Sets the execution/runner mode for interactive Hilbish.
This determines whether Hilbish wll try to run input as Lua
and/or sh or only do one of either.
Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
sh, and lua. It also accepts a function, to which if it is passed one
will call it to execute user input instead.
Read about runner mode
for more information.
string|function mode
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.
Checks if name is a valid command.
Will return the path of the binary, or a basename if it’s a commander.
string name
A sink is a structure that has input and/or output to/from a desination.
Sets/toggles the option of automatically flushing output. A call with no argument will toggle the value.
Flush writes all buffered input to the sink.
Reads a liine of input from the sink.
Reads all input from the sink.
Writes data to a sink.
Writes data to a sink with a newline at the end.
Want to help improve this page? Create an issue.