mirror of
https://github.com/Hilbis/Hilbish
synced 2025-05-06 04:13:24 +00:00
41 lines
6.8 KiB
HTML
41 lines
6.8 KiB
HTML
<!doctype html>
|
||
<html class="bg-stone-50 dark:bg-neutral-950 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="./hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name="description"><meta content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content="https://rosettea.github.io/Hilbish/versions/new-website" property="og:url"></head><body><nav class="flex sticky top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-6" src="/hilbish-flower.png"><span class="self-center text-2xl">Hilbish</span></a></div></div></nav><div class="flex flex-col"><div class="block sm:hidden h-10 sticky top-12 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 z-50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-black"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span>Runner Mode</span></div><div class="grid sm:flex"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="border-r border-r-zinc-300 col-start-1 row-start-1 sticky top-22 sm:top-12 h-full sm:h-svh bg-neutral-200 basis-3/5 transition-transform duration-300 -translate-x-full sm:translate-x-0 peer-checked:translate-x-0 z-30"><div class="p-4 -mb-4 overflow-y-auto h-full"><h2 class="text-xl font-semibold mb-4">Sidebar</h2><ul><li class="mb-2">Lunacolors</li><li class="mb-2">Introduction</li><li class="mb-2">Completions</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Options</li><li class="mb-2">Features</li><li class="mb-2">Runner Mode</li><li class="mb-2">Notification</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Command</li><li class="mb-2">Hilbish</li><li class="mb-2">Vim Mode</li><li class="mb-2">Actions</li><li class="mb-2">Module bait</li><li class="mb-2">Module terminal</li><li class="mb-2">API</li><li class="mb-2">Module fs</li><li class="mb-2">Module commander</li><li class="mb-2">Module snail</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module dirs</li><li class="mb-2">Nature</li><li class="mb-2">Module doc</li></ul></div></div><main class="col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30 px-4 pt-2"><h1>Runner Mode</h1><Tag xmlns="namespace"><p>Hilbish allows you to change how interactive text can be interpreted.
|
||
This is mainly due to the fact that the default method Hilbish uses
|
||
is that it runs Lua first and then falls back to shell script.</p>
|
||
<p>In some cases, someone might want to switch to just shell script to avoid
|
||
it while interactive but still have a Lua config, or go full Lua to use
|
||
Hilbish as a REPL. This also allows users to add alternative languages like
|
||
Fennel as the interactive script runner.</p>
|
||
<p>Runner mode can also be used to handle specific kinds of input before
|
||
evaluating like normal, which is how <a href="https://github.com/TorchedSammy/Link.hsh" rel="noopener noreferrer">Link.hsh</a>
|
||
handles links.</p>
|
||
<p>The “runner mode” of Hilbish is customizable via <code>hilbish.runnerMode</code>,
|
||
which determines how Hilbish will run user input. By default, this is
|
||
set to <code>hybrid</code> which is the previously mentioned behaviour of running Lua
|
||
first then going to shell script. If you want the reverse order, you can
|
||
set it to <code>hybridRev</code> and for isolated modes there is <code>sh</code> and <code>lua</code>
|
||
respectively.</p>
|
||
<p>You can also set it to a function, which will be called everytime Hilbish
|
||
needs to run interactive input. For more detail, see the <a href="../../api/hilbish/hilbish.runner" rel="noopener noreferrer">API documentation</a></p>
|
||
<p>The <code>hilbish.runner</code> interface is an alternative to using <code>hilbish.runnerMode</code>
|
||
and also provides the shell script and Lua runner functions that Hilbish itself uses.</p>
|
||
<h2>Functions</h2>
|
||
<p>These are the “low level” functions for the <code>hilbish.runner</code> interface.</p>
|
||
<ul>
|
||
<li>setMode(mode) > The same as <code>hilbish.runnerMode</code></li>
|
||
<li>sh(input) -> table > Runs <code>input</code> in Hilbish’s sh interpreter</li>
|
||
<li>lua(input) -> table > Evals <code>input</code> as Lua code</li>
|
||
</ul>
|
||
<p>These functions should be preferred over the previous ones.</p>
|
||
<ul>
|
||
<li>setCurrent(mode) > The same as <code>setMode</code>, but works with runners managed
|
||
via the functions below.</li>
|
||
<li>add(name, runner) > Adds a runner to a table of available runners. The <code>runner</code>
|
||
argument is either a function or a table with a run callback.</li>
|
||
<li>set(name, runner) > The same as <code>add</code> but requires passing a table and
|
||
overwrites if the <code>name</code>d runner already exists.</li>
|
||
<li>get(name) > runner > Gets a runner by name. It is a table with at least a
|
||
run function, to run input.</li>
|
||
<li>exec(cmd, runnerName) > Runs <code>cmd</code> with a runner. If <code>runnerName</code> isn’t passed,
|
||
the current runner mode is used.</li>
|
||
</ul></Tag></main></div></div><footer class="py-4 px-6 flex flex-row justify-around border-t border-t-zinc-300"><div class="flex flex-col"><a class="flex items-center gap-1" href="/"><img class="h-24" src="/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish"><span class="text-pink-300 text-light">GitHub</span></a></div></footer></body></html> |