Module hilbish

hilbish.alias(cmd, orig)

Sets an alias, with a name of cmd to another command.

Parameters

string cmd
Name of the alias

string orig
Command that will be aliased

Example

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).

hilbish.appendPath(dir)

Appends the provided dir to the command path ($PATH)

Parameters

string|table dir
Directory (or directories) to append to path

Example

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}

hilbish.complete(scope, cb)

Registers a completion handler for the specified scope.
A scope is expected to be command.<cmd>,
replacing with the name of the command (for example command.git).
The documentation for completions, under Features/Completions or doc completions
provides more details.

Parameters

string scope

function cb

Example

 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)

hilbish.cwd() -> string

Returns the current directory of the shell.

Parameters

This function has no parameters.

hilbish.exec(cmd)

Replaces the currently running Hilbish instance with the supplied command.
This can be used to do an in-place restart.

Parameters

string cmd

hilbish.goro(fn)

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.

Parameters

function fn

hilbish.highlighter(line)

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.

Parameters

string line

Example

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

hilbish.hinter(line, pos)

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.

Parameters

string line

number pos
Position of cursor in line. Usually equals string.len(line)

Example

1-- this will display "hi" after the cursor in a dimmed color.
2function hilbish.hinter(line, pos)
3	return 'hi'
4end

hilbish.inputMode(mode)

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.

Parameters

string mode
Can be set to either emacs or vim

hilbish.interval(cb, time) -> Timer

Runs the cb function every specified amount of time.
This creates a timer that ticking immediately.

Parameters

function cb

number time
Time in milliseconds.

hilbish.multiprompt(str)

Changes the text prompt when Hilbish asks for more input.
This will show up when text is incomplete, like a missing quote

Parameters

string str

Example

 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 '-->'

hilbish.prependPath(dir)

Prepends dir to $PATH.

Parameters

string dir

hilbish.prompt(str, typ)

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

Parameters

string str

string typ?
Type of prompt, being left or right. Left by default.

Example

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 $

hilbish.read(prompt) -> input (string)

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.

Parameters

string prompt?
Text to print before input, can be empty.

hilbish.run(cmd, streams) -> exitCode (number), stdout (string), stderr (string)

Runs cmd in Hilbish’s shell script interpreter.
The streams parameter specifies the output and input streams the command should use.
For example, to write command output to a sink.
As a table, the caller can directly specify the standard output, error, and input
streams of the command with the table keys out, err, and input respectively.
As a boolean, it specifies whether the command should use standard output or return its output streams.

Parameters

string cmd

table|boolean streams

Example

 1
 2// This code is the same as `ls -l | wc -l`
 3local fs = require 'fs'
 4local pr, pw = fs.pipe()
 5hilbish.run('ls -l', {
 6	stdout = pw,
 7	stderr = pw,
 8})
 9
10pw:close()
11
12hilbish.run('wc -l', {
13	stdin = pr
14})

hilbish.runnerMode(mode)

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.

Parameters

string|function mode

hilbish.timeout(cb, time) -> Timer

Executed the cb function after a period of time.
This creates a Timer that starts ticking immediately.

Parameters

function cb

number time
Time to run in milliseconds.

hilbish.which(name) -> string

Checks if name is a valid command.
Will return the path of the binary, or a basename if it’s a commander.

Parameters

string name