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

39 lines
1.4 KiB
Plaintext
Raw Normal View History

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
alias(cmd, orig) > Sets an alias of `orig` to `cmd`
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`).
`cb` must be a function that returns a table of the entries to complete.
Nested tables will be used as sub-completions.
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`
docs: add docs for functions
2021-10-16 19:38:49 +00:00
flag(f) > Checks if the `f` flag has been passed to Hilbish.
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
goro(fn) > Puts `fn` in a goroutine
interval(cb, time) > Runs the `cb` function every `time` milliseconds
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)
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
run(cmd) > Runs `cmd` in Hilbish's sh interpreter.
timeout(cb, time) > Runs the `cb` function after `time` in milliseconds