| 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. Does not
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.
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. |
| 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 |
Returns the current directory of the shell
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.
NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.
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
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
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. Accepts either emacs or vim.emacs is the default. Setting it to vim changes behavior of input to be
Vim-like with modes and Vim keybinds.
string mode
Runs the cb function every time milliseconds.
This creates a timer that starts immediately.
function cb
number time
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--[[
@@ -104,14 +104,15 @@ interfaces and functions which directly relate to shell functionality.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 (which shouldn’t happen).
string prompt?
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.
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
Runs the cb function after time in milliseconds.
This creates a Timer that starts immediately.
function cb
number time
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