mirror of
https://github.com/Hilbis/Hilbish
synced 2025-07-01 16:52:03 +00:00
19 lines
10 KiB
HTML
19 lines
10 KiB
HTML
<!doctype html>
|
|
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="http://localhost:9080/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="http://localhost:9080/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="http://localhost:9080" property="og:url"></head><body class="h-screen flex flex-col"><nav class="bg-stone-100/80 dark:bg-neutral-950/80 flex justify-around sticky items-center 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-8" src="http://localhost:9080/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3"><a href="http://localhost:9080/install"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Install</span></a><a href="http://localhost:9080/docs"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Docs</span></a><a href="http://localhost:9080/blog"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Blog</span></a></div></nav><div class="flex-1 flex flex-col overflow-hidden"><div class="sm:hidden h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/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-white"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span class="font-bold">Runner Mode</span></div><div class="flex-1 sm:flex grid overflow-hidden"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="overflow-y-scroll p-4 sm:border-r sm:border-r-zinc-300 col-start-1 row-start-1 bg-neutral-100 dark:bg-neutral-950 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul class="text-lg flex flex-col gap-2"><li class="font-bold"><a href="http://localhost:9080/docs">Introduction</a></li><li class="font-bold"><a href="http://localhost:9080/docs/getting-started">Getting Started</a></li><li class="font-bold"><a href="http://localhost:9080/docs/faq">Frequently Asked Questions</a></li><li class="font-bold"><a href="http://localhost:9080/docs/features">Features</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/completions">Completions</a></li><li class="mb-2"><a href="http://localhost:9080/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="http://localhost:9080/docs/features/opts">Options</a></li><li class="mb-2 text-pink-400"><a href="http://localhost:9080/docs/features/runner-mode"> -> Runner Mode</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/hooks">Signals</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/hooks/command">Command</a></li><li class="mb-2"><a href="http://localhost:9080/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="http://localhost:9080/docs/hooks/signal">Signal</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/lunacolors">Lunacolors</a></li><li class="font-bold"><a href="http://localhost:9080/docs/api">API</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/readline">Module readline</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/yarn">Module yarn</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/nature">Nature</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="http://localhost:9080/docs/nature/doc">Module doc</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/vim-mode">Vim Mode</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/vim-mode/actions">Actions</a></li></ul></ul></div><main class="flex-1 flex justify-center basis-7/7 col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30"><div class="flex-1 flex flex-col overflow-y-auto"><div class="flex-1 w-3/4 self-center p-8"><h1 class="my-3 font-bold text-4xl">Runner Mode</h1><i>Customize the interactive script/command runner.</i><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.<br> <br>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.<br> <br>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">Link.hsh</a>
|
|
handles links.<br> <br>The "runner mode" of Hilbish is customizable via <code class="text-violet-600 dark:text-violet-400">hilbish.runnerMode</code>,
|
|
which determines how Hilbish will run user input. By default, this is
|
|
set to <code class="text-violet-600 dark:text-violet-400">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 class="text-violet-600 dark:text-violet-400">hybridRev</code> and for isolated modes there is <code class="text-violet-600 dark:text-violet-400">sh</code> and <code class="text-violet-600 dark:text-violet-400">lua</code>
|
|
respectively.<br> <br>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">API documentation</a><br> <br>The <code class="text-violet-600 dark:text-violet-400">hilbish.runner</code> interface is an alternative to using <code class="text-violet-600 dark:text-violet-400">hilbish.runnerMode</code>
|
|
and also provides the shell script and Lua runner functions that Hilbish itself uses.</p><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><p>These are the "low level" functions for the <code class="text-violet-600 dark:text-violet-400">hilbish.runner</code> interface.</p><ul style="list-style-type:'-';"><li><p>setMode(mode) > The same as <code class="text-violet-600 dark:text-violet-400">hilbish.runnerMode</code></p></li><li><p>sh(input) -> table > Runs <code class="text-violet-600 dark:text-violet-400">input</code> in Hilbish's sh interpreter</p></li><li><p>lua(input) -> table > Evals <code class="text-violet-600 dark:text-violet-400">input</code> as Lua code</p></li></ul><p>These functions should be preferred over the previous ones.</p><ul style="list-style-type:'-';"><li><p>setCurrent(mode) > The same as <code class="text-violet-600 dark:text-violet-400">setMode</code>, but works with runners managed via the functions below.</p></li><li><p>add(name, runner) > Adds a runner to a table of available runners. The <code class="text-violet-600 dark:text-violet-400">runner</code> argument is either a function or a table with a run callback.</p></li><li><p>set(name, runner) > The same as <code class="text-violet-600 dark:text-violet-400">add</code> but requires passing a table and overwrites if the <code class="text-violet-600 dark:text-violet-400">name</code>d runner already exists.</p></li><li><p>get(name) > runner > Gets a runner by name. It is a table with at least a run function, to run input.</p></li><li><p>exec(cmd, runnerName) > Runs <code class="text-violet-600 dark:text-violet-400">cmd</code> with a runner. If <code class="text-violet-600 dark:text-violet-400">runnerName</code> isn't passed, the current runner mode is used.</p></li></ul></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="http://localhost:9080"><img class="h-24" src="http://localhost:9080/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" target="_blank"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline"><tag><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6">
|
|
<path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25" />
|
|
</svg>
|
|
</tag>GitHub</span></a></div></footer></div></main></div></div></body></html> |