sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity
Hilbish/docs/hilbish.txt

64 lines
2.8 KiB
Plaintext
Raw Normal View History

docs: [ci] generate new docs
2022-03-20 21:54:55 +00:00
alias(cmd, orig) > Sets an alias of `cmd` to `orig`
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
appendPath(dir) > Appends `dir` to $PATH
complete(scope, cb) > Registers a completion handler for `scope`.
A `scope` is currently only expected to be `command.<cmd>`,
replacing <cmd> with the name of the command (for example `command.git`).
docs: [ci] generate new docs
2022-03-05 20:13:15 +00:00
`cb` must be a function that returns a table of "completion groups."
A completion group is a table with the keys `items` and `type`.
`items` being a table of items and `type` being the display type of
`grid` (the normal file completion display) or `list` (with a description)
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
docs: add docs for functions
2021-10-16 19:38:49 +00:00
cwd() > Returns the current directory of the shell
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
exec(cmd) > Replaces running hilbish with `cmd`
goro(fn) > Puts `fn` in a goroutine
docs: [ci] generate new docs
2022-03-26 22:28:27 +00:00
highlighter(cb) > Sets the highlighter function. This is mainly for syntax hightlighting, but in
reality could set the input of the prompt to display anything. The callback
is passed the current line as typed and is expected to return a line that will
be used to display in the line.
docs: [ci] generate new docs
2022-03-26 21:34:42 +00:00
hinter(cb) > Sets the hinter function. This will be called on every key insert to determine
what text to use as an inline hint. The callback is passed 2 arguments:
the current line and the position. It is expected to return a string
which will be used for the hint.
docs: [ci] generate new docs
2022-03-02 02:01:22 +00:00
inputMode(mode) > Sets the input mode for Hilbish's line reader. Accepts either emacs for vim
docs: [ci] generate new docs
2022-04-12 23:37:39 +00:00
interval(cb, time) > Runs the `cb` function every `time` milliseconds.
Returns a `timer` object (see `doc timers`).
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
multiprompt(str) > Changes the continued line prompt to `str`
prependPath(dir) > Prepends `dir` to $PATH
fix(docgen): remove trailing spaces in docs
2022-02-25 00:42:54 +00:00
prompt(str) > Changes the shell prompt to `str`
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
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
feat: add hilbish.read function `hilbish.read` will read input from the user, using hilbish's line editor library (hilbiline or readline)
2021-10-30 23:53:42 +00:00
read(prompt) -> input? > 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)
docs: [ci] generate new docs
2022-04-04 10:40:25 +00:00
run(cmd, returnOut) -> exitCode, stdout, stderr > Runs `cmd` in Hilbish's sh interpreter.
If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
3rd values instead of being outputted to the terminal.
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
docs: [ci] generate new docs
2022-03-20 19:16:13 +00:00
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.
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
timeout(cb, time) > Runs the `cb` function after `time` in milliseconds
docs: [ci] generate new docs
2022-04-12 23:37:39 +00:00
Returns a `timer` object (see `doc timers`).
docs: [ci] regenerate new docs
2022-02-25 22:00:39 +00:00
docs: [ci] generate new docs
2022-03-01 23:00:20 +00:00
which(binName) > Searches for an executable called `binName` in the directories of $PATH