mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-21 21:13:22 +00:00
sammyette
e5eefb1d2d
changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
32 lines
970 B
Markdown
32 lines
970 B
Markdown
---
|
|
title: Interface hilbish.runner
|
|
description: interactive command runner customization
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
The runner interface contains functions that allow the user to change
|
|
how Hilbish interprets interactive input.
|
|
Users can add and change the default runner for interactive input to any
|
|
language or script of their choosing. A good example is using it to
|
|
write command in Fennel.
|
|
|
|
## Functions
|
|
### setMode(cb)
|
|
This is the same as the `hilbish.runnerMode` function. It takes a callback,
|
|
which will be used to execute all interactive input.
|
|
In normal cases, neither callbacks should be overrided by the user,
|
|
as the higher level functions listed below this will handle it.
|
|
|
|
### lua(cmd)
|
|
Evaluates `cmd` as Lua input. This is the same as using `dofile`
|
|
or `load`, but is appropriated for the runner interface.
|
|
|
|
### sh(cmd)
|
|
Runs a command in Hilbish's shell script interpreter.
|
|
This is the equivalent of using `source`.
|
|
|