Module hilbish.aliases

command aliasing

Introduction#

The alias interface manages command aliases in Hilbish. An alias is a short name that expands to a longer command when entered at the prompt. Aliases are stored as-is in history (the short name, not the expanded command).

Aliases support numbered argument substitution. %1 in the alias body is replaced by the first argument, %2 by the second, and so on. %0 is passed through literally. A substitution can be escaped by prefixing it with \.

Functions#

add#

hilbish.aliases.add(alias, cmd)

This is an alias (ha) for the hilbish.alias function.

Parameters#

string alias

string cmd

See also#

delete#

hilbish.aliases.delete(alias)

Removes an alias.

Parameters#

string alias

list#

hilbish.aliases.list() -> table<string, string>

Returns a table of all defined aliases. Keys are the alias names and values are the command strings they expand to.

Returns#

table<string, string> A table mapping alias names to their command strings.

Example#

hilbish.aliases.add('hi', 'echo hi')
local aliases = hilbish.aliases.list()
-- -> {hi = 'echo hi'}

resolve#

hilbish.aliases.resolve(cmdstr) -> string

Resolves an alias to its original command. Will thrown an error if the alias doesn't exist.

Parameters#

string cmdstr

Returns#

string