sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-01 16:52:03 +00:00
Code Issues Releases Wiki Activity

deploy: cffac79d4f90f398b981092a30ae318495a14fd5

Browse Source
This commit is contained in:
sammy-ette 2025-06-12 23:37:18 +00:00
parent 2da95b4197
commit cd480b5920
54 changed files with 1026 additions and 1629 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
versions/new-website/blog/improving-this-website/index.html
View File

@ -1,8 +1,8 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Improving Hilbish&#39;s Branding</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Improving Hilbish&#39;s Branding</h1><p>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Improving Hilbish&#39;s Branding</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Improving Hilbish&#39;s Branding</h1><p>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old.
Unfortunately I missed the official date, but I will still make a more Unfortunately I missed the official date, but I will still make a more
focused post on the date (19st).</p><p>I decided to fix up this website and Hilbish&#39;s logo, so that can focused post on the date (19st).</p><p>I decided to fix up this website and Hilbish&#39;s logo, so that can
be thought of as something for the 2 years milestone?</p><h1 class="font-bold text-4xl" id="Logo-Hilbish&#39;s-old-logo-was..-not-that-good.-It-definitely-functioned-as-a-logo-but-the-yellow-part-of-it-looked-ugly-(sorry-old-logo).">Logo be thought of as something for the 2 years milestone?</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Logo-Hilbish&#39;s-old-logo-was..-not-that-good.-It-definitely-functioned-as-a-logo-but-the-yellow-part-of-it-looked-ugly-(sorry-old-logo).">Logo
Hilbish&#39;s old logo was.. not that good. It definitely functioned Hilbish&#39;s old logo was.. not that good. It definitely functioned
as a logo, but the yellow part of it looked ugly (sorry old logo).</h1><p>&lt;img src=&quot;https://safe.kashima.moe/4c6e9q484pcy.png&quot; width=256&gt; as a logo, but the yellow part of it looked ugly (sorry old logo).</h1><p>&lt;img src=&quot;https://safe.kashima.moe/4c6e9q484pcy.png&quot; width=256&gt;
&lt;br&gt;</p><p>You would have definitely seen the new logo, since it is currently &lt;br&gt;</p><p>You would have definitely seen the new logo, since it is currently
@ -13,13 +13,13 @@ in use on the navigation bar and footer. Here it is in a bigger view:
# Website # Website
Ever since this website was first made, from the release of v2.0, it has Ever since this website was first made, from the release of v2.0, it has
been doing it&#39;s job of being a website good enough, but there were a few issues.</p><h1 class="font-bold text-4xl" id="Padding-Padding-is-very-important-The-edges-of-your-screen-need-space-to-do-nothing-after-all.-On-mobile-or-screens-small-enough-there-would-not-be-enough-space-for-the-auto-margin-to-fill-and-since-there-was-no-padding-besides-that-it-means-things-would-look-a-bit-cramped.-This-was-simple-to-fix.">Padding been doing it&#39;s job of being a website good enough, but there were a few issues.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Padding-Padding-is-very-important-The-edges-of-your-screen-need-space-to-do-nothing-after-all.-On-mobile-or-screens-small-enough-there-would-not-be-enough-space-for-the-auto-margin-to-fill-and-since-there-was-no-padding-besides-that-it-means-things-would-look-a-bit-cramped.-This-was-simple-to-fix.">Padding
Padding is very important! The edges of your screen need space to do nothing, Padding is very important! The edges of your screen need space to do nothing,
after all. On mobile or screens small enough, there would not be enough space after all. On mobile or screens small enough, there would not be enough space
for the auto margin to fill, and since there was no padding besides that, for the auto margin to fill, and since there was no padding besides that,
it means things would look a bit cramped. This was simple to fix.</h1><p>Here it is before: it means things would look a bit cramped. This was simple to fix.</h1><p>Here it is before:
<img alt="Before" src="https://safe.kashima.moe/nupzzalt2oa4.png"></p><p>and after: <img alt="Before" src="https://safe.kashima.moe/nupzzalt2oa4.png"></p><p>and after:
<img alt="After" src="https://safe.kashima.moe/r0ox4nazfi0q.png"></p><h1 class="font-bold text-4xl" id="Docs-Navigation-On-the-docs-page-the-pages-are-on-the-left-on-desktop.-Since-phones-are-too-small-to-have-this-content-on-the-side-it-stays-at-the-top.-This-is-a-bit-counter-intuitive-since-it-brings-in-extra-scrolling-when-navigating-to-every-page-for-docs-and-just-doesn&#39;t-look-that-good.">Docs Navigation <img alt="After" src="https://safe.kashima.moe/r0ox4nazfi0q.png"></p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Docs-Navigation-On-the-docs-page-the-pages-are-on-the-left-on-desktop.-Since-phones-are-too-small-to-have-this-content-on-the-side-it-stays-at-the-top.-This-is-a-bit-counter-intuitive-since-it-brings-in-extra-scrolling-when-navigating-to-every-page-for-docs-and-just-doesn&#39;t-look-that-good.">Docs Navigation
On the docs page, the pages are on the left on desktop. Since On the docs page, the pages are on the left on desktop. Since
phones are too small to have this content on the side, it stays at the top. phones are too small to have this content on the side, it stays at the top.
This is a bit counter intuitive since it brings in extra scrolling This is a bit counter intuitive since it brings in extra scrolling
@ -28,8 +28,8 @@ was not hidden by default. So a few improvements were made:
- Make the doc navigation hidden by default on mobile, just like site wide navigation - Make the doc navigation hidden by default on mobile, just like site wide navigation
- Make doc navigation have the same look as site wide navigation</p><p>Here&#39;s a before: - Make doc navigation have the same look as site wide navigation</p><p>Here&#39;s a before:
<img alt src="https://safe.kashima.moe/krn0a6qwegdj.png"></p><p>and after: <img alt src="https://safe.kashima.moe/krn0a6qwegdj.png"></p><p>and after:
<img alt src="https://safe.kashima.moe/sk11ighz47yb.png"></p><p>Looks a lot better now.</p><h1 class="font-bold text-4xl" id="Other-Changes-If-you-haven&#39;t-noticed-I-have-made-other-changes-to-the-website.-This-includes:---Borders-Something-this-simple-makes-the-website-look-a-lot-better-especially-on-mobile.---More-padding-and-margin-everywhere.-Home-doc-pages-blog-post-listing.">Other Changes <img alt src="https://safe.kashima.moe/sk11ighz47yb.png"></p><p>Looks a lot better now.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Other-Changes-If-you-haven&#39;t-noticed-I-have-made-other-changes-to-the-website.-This-includes:---Borders-Something-this-simple-makes-the-website-look-a-lot-better-especially-on-mobile.---More-padding-and-margin-everywhere.-Home-doc-pages-blog-post-listing.">Other Changes
If you haven&#39;t noticed, I have made other changes to the website. If you haven&#39;t noticed, I have made other changes to the website.
This includes: This includes:
- Borders! Something this simple makes the website look a lot better, especially on mobile. - Borders! Something this simple makes the website look a lot better, especially on mobile.
- More padding and margin everywhere. Home, doc pages, blog post listing.</h1></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> - More padding and margin everywhere. Home, doc pages, blog post listing.</h1></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="http://localhost:9080"><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>

44
versions/new-website/blog/v2.0-release/index.html
View File

@ -1,62 +1,62 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Hilbish v2.0 Release</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Hilbish v2.0 Release</h1><p>Hilbish v2.0 has been released! <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Hilbish v2.0 Release</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Hilbish v2.0 Release</h1><p>Hilbish v2.0 has been released!
Well actually, it was released a week ago, but I only wrote this Well actually, it was released a week ago, but I only wrote this
Hilbish blog <strong>after</strong> that.</p><p>This is a *<strong>big</strong>* release, coming 9 months after the previous v1.2.0 and Hilbish blog <strong>after</strong> that.</p><p>This is a *<strong>big</strong>* release, coming 9 months after the previous v1.2.0 and
featuring over 40+ bug fixes and tons of new features and enhancements, so featuring over 40+ bug fixes and tons of new features and enhancements, so
let&#39;s see what is in this release.</p><h1 class="font-bold text-4xl" id="Documentation-When-querying-about-the-problems-people-have-with-Hilbish-one-of-the-issues-was-its-poor-documentation.-Hilbish-had-plain-text-autogenerated-documentation-which-only-covered-the-module-functions-(bait-hilbish-commander-etc.)-and-did-not-include-the-interfaces-(hilbish.timers-hilbish.jobs-and-all-that).">Documentation let&#39;s see what is in this release.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Documentation-When-querying-about-the-problems-people-have-with-Hilbish-one-of-the-issues-was-its-poor-documentation.-Hilbish-had-plain-text-autogenerated-documentation-which-only-covered-the-module-functions-(bait-hilbish-commander-etc.)-and-did-not-include-the-interfaces-(hilbish.timers-hilbish.jobs-and-all-that).">Documentation
When querying about the problems people have with Hilbish, one of the When querying about the problems people have with Hilbish, one of the
issues was its poor documentation. Hilbish had plain text, autogenerated issues was its poor documentation. Hilbish had plain text, autogenerated
documentation which only covered the module functions (bait, hilbish, documentation which only covered the module functions (bait, hilbish,
commander, etc.) and did not include the interfaces (<code>hilbish.timers</code>, commander, etc.) and did not include the interfaces (<code class="text-violet-600 dark:text-violet-400">hilbish.timers</code>,
<code>hilbish.jobs</code> and all that).</h1><p>I have tried to improve this by working on documenting all the <code class="text-violet-600 dark:text-violet-400">hilbish.jobs</code> and all that).</h1><p>I have tried to improve this by working on documenting all the
interfaces (except for some functions of <code>hilbish.runner</code>, that&#39;s hard to do) interfaces (except for some functions of <code class="text-violet-600 dark:text-violet-400">hilbish.runner</code>, that&#39;s hard to do)
and made the documentation markdown for use on this website. This means and made the documentation markdown for use on this website. This means
that users can look at documentation here or with the <code>doc</code> command.</p><p>Hopefully this addresses documentation complaints, and if not, please open an issue.</p><h1 class="font-bold text-4xl" id="Main-Bug-Fixes-As-this-is-a-piece-of-software-with-no-unit-testing-that-is-maintained-by-me-alone-there-is-gonna-be-either-some-bug-or-something-that-I-overlooked-when-making-a-change.-I-make-a-lot-of-mistakes.-There&#39;s-also-the-other-fact-that-sometimes-there&#39;s-just-bugs-for-any-other-reasosn.-Good-thing-I-fixed-more-than-40-of-those-bugs-in-this-release">Main Bug Fixes that users can look at documentation here or with the <code class="text-violet-600 dark:text-violet-400">doc</code> command.</p><p>Hopefully this addresses documentation complaints, and if not, please open an issue.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Main-Bug-Fixes-As-this-is-a-piece-of-software-with-no-unit-testing-that-is-maintained-by-me-alone-there-is-gonna-be-either-some-bug-or-something-that-I-overlooked-when-making-a-change.-I-make-a-lot-of-mistakes.-There&#39;s-also-the-other-fact-that-sometimes-there&#39;s-just-bugs-for-any-other-reasosn.-Good-thing-I-fixed-more-than-40-of-those-bugs-in-this-release">Main Bug Fixes
As this is a piece of software with no unit testing that is maintained by me alone, As this is a piece of software with no unit testing that is maintained by me alone,
there is gonna be either some bug or something that I overlooked when there is gonna be either some bug or something that I overlooked when
making a change. I make a lot of mistakes. There&#39;s also the other fact that making a change. I make a lot of mistakes. There&#39;s also the other fact that
sometimes there&#39;s just bugs for any other reasosn. Good thing I fixed sometimes there&#39;s just bugs for any other reasosn. Good thing I fixed
more than 40 of those bugs in this release!</h1><h2 class="font-bold text-3xl" id="Readline-Bug-Fixes-The-pure-Go-readline-library-is-good-in-some-ways-and-bad-in-others.-A-good-portion-of-the-bug-fixes-are-for-the-readline-library-and-also-related-to-text-input-with-east-asian-characters-and-the-like-(Korean-Japanese-etc.)">Readline Bug Fixes more than 40 of those bugs in this release!</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Readline-Bug-Fixes-The-pure-Go-readline-library-is-good-in-some-ways-and-bad-in-others.-A-good-portion-of-the-bug-fixes-are-for-the-readline-library-and-also-related-to-text-input-with-east-asian-characters-and-the-like-(Korean-Japanese-etc.)">Readline Bug Fixes
The pure Go readline library is good in some ways and bad in others. The pure Go readline library is good in some ways and bad in others.
A good portion of the bug fixes are for the readline library, and also A good portion of the bug fixes are for the readline library, and also
related to text input with east asian characters and the like (Korean, Japanese, related to text input with east asian characters and the like (Korean, Japanese,
etc.)</h2><p>A few of the fixes (and additions) include:</p><ul style="list-style-type:&#39;-&#39;;"><li><p>Fixing various crashes, including when there is a &quot;stray&quot; newline at the end of text</p></li><li><p>Grid completion menu causing spam and duplicate text when there are items longer than</p></li></ul><p>the terminal and/or contain Japanese or other characters. etc.)</h2><p>A few of the fixes (and additions) include:</p><ul style="list-style-type:&#39;-&#39;;"><li><p>Fixing various crashes, including when there is a &quot;stray&quot; newline at the end of text</p></li><li><p>Grid completion menu causing spam and duplicate text when there are items longer than</p></li></ul><p>the terminal and/or contain Japanese or other characters.
- Cursor positioning with CJK characters - Cursor positioning with CJK characters
- Adding new keybinds and fixing others</p><h2 class="font-bold text-3xl" id="Other-fixes-There-are-a-lot-more-fixes-even-more-than-the-ones-listed-here-but-these-are-the-main-ones:- --Don&#39;t-put-alias-expanded-command-in-history-(I&#39;ve-fixed-this-5-times-now....)- --Handle-stdin-being-nonblocking- --Completion-related-fixes-like-showing-the-full-name-completing-files-with-spaces">Other fixes - Adding new keybinds and fixing others</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Other-fixes-There-are-a-lot-more-fixes-even-more-than-the-ones-listed-here-but-these-are-the-main-ones:- --Don&#39;t-put-alias-expanded-command-in-history-(I&#39;ve-fixed-this-5-times-now....)- --Handle-stdin-being-nonblocking- --Completion-related-fixes-like-showing-the-full-name-completing-files-with-spaces">Other fixes
There are a lot more fixes, even more than the ones listed here, but these are the main ones: There are a lot more fixes, even more than the ones listed here, but these are the main ones:
- Don&#39;t put alias expanded command in history (I&#39;ve fixed this 5 times now....) - Don&#39;t put alias expanded command in history (I&#39;ve fixed this 5 times now....)
- Handle stdin being nonblocking - Handle stdin being nonblocking
- Completion related fixes, like showing the full name, completing files with spaces</h2><h1 class="font-bold text-4xl" id="Breaking-changes-This-release-is-a-major-version-bump-not-only-because-there-are-tons-of-fixes-but-because-there-are-breaking-changes.-This-means-that-there-are-some-changes-done-which-would-cause-errors-with-an-old-user-config-(breaking).">Breaking changes - Completion related fixes, like showing the full name, completing files with spaces</h2><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Breaking-changes-This-release-is-a-major-version-bump-not-only-because-there-are-tons-of-fixes-but-because-there-are-breaking-changes.-This-means-that-there-are-some-changes-done-which-would-cause-errors-with-an-old-user-config-(breaking).">Breaking changes
This release is a major version bump not only because there are tons of fixes, but because This release is a major version bump not only because there are tons of fixes, but because
there are breaking changes. This means that there are some changes done which would there are breaking changes. This means that there are some changes done which would
cause errors with an old user config (breaking).</h1><h2 class="font-bold text-3xl" id="Lua-5.4-The-most-important-is-the-use-of-a-new-Lua-VM-library.-Previously-Hilbish-used-gopher-lua-which-implements-Lua-5.1.-This-has-been-changed-to-golua-which-implements-Lua-5.4.">Lua 5.4 cause errors with an old user config (breaking).</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Lua-5.4-The-most-important-is-the-use-of-a-new-Lua-VM-library.-Previously-Hilbish-used-gopher-lua-which-implements-Lua-5.1.-This-has-been-changed-to-golua-which-implements-Lua-5.4.">Lua 5.4
The most important is the use of a new Lua VM library. Previously, Hilbish The most important is the use of a new Lua VM library. Previously, Hilbish
used gopher-lua, which implements Lua 5.1. This has been changed to used gopher-lua, which implements Lua 5.1. This has been changed to
<a href="https://github.com/arnodel/golua/">golua</a>, which implements Lua 5.4.</h2><p>Moving from 5.1 to 5.4 does have breaking changes even if it doesn&#39;t seem like it, <a href="https://github.com/arnodel/golua/">golua</a>, which implements Lua 5.4.</h2><p>Moving from 5.1 to 5.4 does have breaking changes even if it doesn&#39;t seem like it,
and since these are different Lua implementations, there may be some differences there too.</p><h2 class="font-bold text-3xl" id="Userdata-Previously-objects-such-as-jobs-or-timers-were-represented-by-tables.-This-has-been-changed-to-userdata-to-make-more-sense.">Userdata and since these are different Lua implementations, there may be some differences there too.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Userdata-Previously-objects-such-as-jobs-or-timers-were-represented-by-tables.-This-has-been-changed-to-userdata-to-make-more-sense.">Userdata
Previously, objects such as jobs or timers were represented by tables. Previously, objects such as jobs or timers were represented by tables.
This has been changed to userdata to make more sense.</h2><h2 class="font-bold text-3xl" id="Other-changes-Runner-functions-are-now-required-to-return-a-table.-It-can-(at-the-moment)-have-4-variables:---input-(user-input)---exitCode-(exit-code)---error-(error-message)---continue-(whether-to-prompt-for-more-input)-User-input-has-been-added-to-the-return-to-account-for-runners-wanting-to-prompt-for-continued-input-and-to-add-it-properly-to-history.-continue-got-added-so-that-it-would-be-easier-for-runners-to-get-continued-input-without-having-to-actually-handle-it-at-all.">Other changes This has been changed to userdata to make more sense.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Other-changes-Runner-functions-are-now-required-to-return-a-table.-It-can-(at-the-moment)-have-4-variables:---input-(user-input)---exitCode-(exit-code)---error-(error-message)---continue-(whether-to-prompt-for-more-input)-User-input-has-been-added-to-the-return-to-account-for-runners-wanting-to-prompt-for-continued-input-and-to-add-it-properly-to-history.-continue-got-added-so-that-it-would-be-easier-for-runners-to-get-continued-input-without-having-to-actually-handle-it-at-all.">Other changes
Runner functions are now required to return a table. Runner functions are now required to return a table.
It can (at the moment) have 4 variables: It can (at the moment) have 4 variables:
- <code>input</code> (user input) - <code class="text-violet-600 dark:text-violet-400">input</code> (user input)
- <code>exitCode</code> (exit code) - <code class="text-violet-600 dark:text-violet-400">exitCode</code> (exit code)
- <code>error</code> (error message) - <code class="text-violet-600 dark:text-violet-400">error</code> (error message)
- <code>continue</code> (whether to prompt for more input) - <code class="text-violet-600 dark:text-violet-400">continue</code> (whether to prompt for more input)
User input has been added to the return to account for runners wanting to User input has been added to the return to account for runners wanting to
prompt for continued input, and to add it properly to history. <code>continue</code> prompt for continued input, and to add it properly to history. <code class="text-violet-600 dark:text-violet-400">continue</code>
got added so that it would be easier for runners to get continued input got added so that it would be easier for runners to get continued input
without having to actually handle it at all.</h2><p>The MacOS config paths now match Linux, since it makes more sense for without having to actually handle it at all.</h2><p>The MacOS config paths now match Linux, since it makes more sense for
a program like Hilbish.</p><p>The Hilbish greeting is now an <strong>opt</strong>, and is printed by default.</p><h1 class="font-bold text-4xl" id="Feature-Additions-Besides-fixes-and-changes-this-release-also-includes-a-good-portion-of-new-features-Users-can-now-add-handlers-for-syntax-highlighting-and-inline-hinting.">Feature Additions a program like Hilbish.</p><p>The Hilbish greeting is now an <strong>opt</strong>, and is printed by default.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Feature-Additions-Besides-fixes-and-changes-this-release-also-includes-a-good-portion-of-new-features-Users-can-now-add-handlers-for-syntax-highlighting-and-inline-hinting.">Feature Additions
Besides fixes and changes, this release also includes a good portion of Besides fixes and changes, this release also includes a good portion of
new features! Users can now add handlers for syntax highlighting and new features! Users can now add handlers for syntax highlighting and
inline hinting.</h1><p>Some new hooks have been added, like <code>hilbish.cancel</code> and <code>hilbish.init</code>. inline hinting.</h1><p>Some new hooks have been added, like <code class="text-violet-600 dark:text-violet-400">hilbish.cancel</code> and <code class="text-violet-600 dark:text-violet-400">hilbish.init</code>.
You can look at all the hooks via the <code>doc hooks</code> command</p><p>Job management functions have also been added. You can now put jobs in the You can look at all the hooks via the <code class="text-violet-600 dark:text-violet-400">doc hooks</code> command</p><p>Job management functions have also been added. You can now put jobs in the
foreground/background and disown them via the expected commands and also foreground/background and disown them via the expected commands and also
via the Lua API.</p><p>The <code>hilbish.timers</code> API interface was also added in this release!</p><h1 class="font-bold text-4xl" id="Closing-Off-Hilbish-has-gone-from-something-small-and-simple-for-myself-to-a-slightly-advanced-shell-with-a-decent-amount-of-features-and-a-few-users.-It-still-hasn&#39;t-reached-levels-of-other-alt-shells-in-regards-to-literally-everything-but-the-goal-is-to-get-there">Closing Off via the Lua API.</p><p>The <code class="text-violet-600 dark:text-violet-400">hilbish.timers</code> API interface was also added in this release!</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Closing-Off-Hilbish-has-gone-from-something-small-and-simple-for-myself-to-a-slightly-advanced-shell-with-a-decent-amount-of-features-and-a-few-users.-It-still-hasn&#39;t-reached-levels-of-other-alt-shells-in-regards-to-literally-everything-but-the-goal-is-to-get-there">Closing Off
Hilbish has gone from something small and simple for myself to a slightly Hilbish has gone from something small and simple for myself to a slightly
advanced shell with a decent amount of features, and a few users. It advanced shell with a decent amount of features, and a few users. It
still hasn&#39;t reached levels of other alt shells in regards to literally still hasn&#39;t reached levels of other alt shells in regards to literally
everything, but the goal is to get there!</h1><p>If you want to check the FULL changelog, you can <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.0.0">do so here.</a> everything, but the goal is to get there!</h1><p>If you want to check the FULL changelog, you can <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.0.0">do so here.</a>
This v2.0 release marks an advancement in Hilbish (and also how long This v2.0 release marks an advancement in Hilbish (and also how long
one of my projects hasn&#39;t died) and I hope it can advance even further.</p><p>Thanks for reading, and I&#39;ll be back for the v2.1 release notes, or maybe one of my projects hasn&#39;t died) and I hope it can advance even further.</p><p>Thanks for reading, and I&#39;ll be back for the v2.1 release notes, or maybe
something else in between.</p></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> something else in between.</p></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="http://localhost:9080"><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>

30
versions/new-website/blog/v2.1-release/index.html
View File

@ -1,36 +1,36 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>v2.1 Release</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">v2.1 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>v2.1 Release</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">v2.1 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be
seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.1.0">v2.1.0</a> seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.1.0">v2.1.0</a>
tag.</p><p>Oh look! A new release of Hilbish! This time is the v2.1 release, tag.</p><p>Oh look! A new release of Hilbish! This time is the v2.1 release,
with a small amount of features and mainly documentation changes and with a small amount of features and mainly documentation changes and
bug fixes.</p><h1 class="font-bold text-4xl" id="Documentation-There-have-been-a-few-documentation-enhancements-for-this-release.-This-includes:---Adding-the-return-types-for-all-functions-that-need-them---Documenting-Hilbish-types-like-job-objects-and-timers-properly.-They-now-have-a-separate-heading-and-listing-of-properties-and-methods.---Fixing-outdated-documentation">Documentation bug fixes.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Documentation-There-have-been-a-few-documentation-enhancements-for-this-release.-This-includes:---Adding-the-return-types-for-all-functions-that-need-them---Documenting-Hilbish-types-like-job-objects-and-timers-properly.-They-now-have-a-separate-heading-and-listing-of-properties-and-methods.---Fixing-outdated-documentation">Documentation
There have been a few documentation enhancements for this release. There have been a few documentation enhancements for this release.
This includes: This includes:
- Adding the return types for all functions that need them - Adding the return types for all functions that need them
- Documenting Hilbish types like job objects and timers properly. - Documenting Hilbish types like job objects and timers properly.
They now have a separate heading and listing of properties and methods. They now have a separate heading and listing of properties and methods.
- Fixing outdated documentation</h1><h1 class="font-bold text-4xl" id="Features">Features</h1><h2 class="font-bold text-3xl" id="Sinks-A-major-addition-is-the-new-&quot;sink&quot;-type-for-commanders-to-write-their-output-to.-This-was-the-solution-to-pipes-and-other-shell-operators-not-working-with-builtins.-If-you-wrote-a-commander-and-made-it-print-use-sinks.out:write-instead.">Sinks - Fixing outdated documentation</h1><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Features">Features</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Sinks-A-major-addition-is-the-new-&quot;sink&quot;-type-for-commanders-to-write-their-output-to.-This-was-the-solution-to-pipes-and-other-shell-operators-not-working-with-builtins.-If-you-wrote-a-commander-and-made-it-print-use-sinks.out:write-instead.">Sinks
A major addition is the new &quot;sink&quot; type for commanders to write A major addition is the new &quot;sink&quot; type for commanders to write
their output to. This was the solution to pipes and other shell their output to. This was the solution to pipes and other shell
operators not working with builtins. If you wrote a commander operators not working with builtins. If you wrote a commander
and made it <code>print</code>, use <code>sinks.out:write</code> instead.</h2><p>This is also documented at the <a href="./docs/api/commander">commander docs</a>.</p><h2 class="font-bold text-3xl" id="doc-command-Since-API-documentation-has-been-moved-to-an-API-folder-and-also-includes-interfaces-a-change-has-been-made-to-get-the-module-name-from-the-passed-from-the-requested-page.-This-means-that-doc-api-hilbish-hilbish.jobs-is-now-shortened-to-doc-api-hilbish.jobs"><code>doc</code> command and made it <code class="text-violet-600 dark:text-violet-400">print</code>, use <code class="text-violet-600 dark:text-violet-400">sinks.out:write</code> instead.</h2><p>This is also documented at the <a href="./docs/api/commander">commander docs</a>.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="doc-command-Since-API-documentation-has-been-moved-to-an-API-folder-and-also-includes-interfaces-a-change-has-been-made-to-get-the-module-name-from-the-passed-from-the-requested-page.-This-means-that-doc-api-hilbish-hilbish.jobs-is-now-shortened-to-doc-api-hilbish.jobs"><code class="text-violet-600 dark:text-violet-400">doc</code> command
Since API documentation has been moved to an API folder and also includes Since API documentation has been moved to an API folder and also includes
interfaces, a change has been made to get the module name from the interfaces, a change has been made to get the module name from the
passed from the requested page. This means that passed from the requested page. This means that
<code>doc api hilbish hilbish.jobs</code> is now shortened to <code>doc api hilbish.jobs</code></h2><h1 class="font-bold text-4xl" id="Bug-Fixes-Small-release-small-amount-of-bug-fixes.-Even-though-this-is-the-main-part-of-this-release.">Bug Fixes <code class="text-violet-600 dark:text-violet-400">doc api hilbish hilbish.jobs</code> is now shortened to <code class="text-violet-600 dark:text-violet-400">doc api hilbish.jobs</code></h2><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Bug-Fixes-Small-release-small-amount-of-bug-fixes.-Even-though-this-is-the-main-part-of-this-release.">Bug Fixes
Small release, small amount of bug fixes. Even though, this is the main Small release, small amount of bug fixes. Even though, this is the main
part of this release.</h1><h2 class="font-bold text-3xl" id="Completions-and-Symlinks-Previously-Hilbish-completions-did-not-work-with-symlinks-properly.-This-can-be-tested-in-the-previous-2.0-release-by-attempting-to-path-complete-to-/bin.-Since-this-is-(or-can-be)-a-symlink-to-/usr/bin-it-was-not-marked-as-a-directory-and-therefore-did-not-automatically-add-the-ending-slash.-This-has-been-fixed.">Completions and Symlinks part of this release.</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Completions-and-Symlinks-Previously-Hilbish-completions-did-not-work-with-symlinks-properly.-This-can-be-tested-in-the-previous-2.0-release-by-attempting-to-path-complete-to-/bin.-Since-this-is-(or-can-be)-a-symlink-to-/usr/bin-it-was-not-marked-as-a-directory-and-therefore-did-not-automatically-add-the-ending-slash.-This-has-been-fixed.">Completions and Symlinks
Previously Hilbish completions did not work with symlinks properly. Previously Hilbish completions did not work with symlinks properly.
This can be tested in the previous 2.0 release by attempting to This can be tested in the previous 2.0 release by attempting to
path complete to <code>/bin</code>. Since this is (or can be?) a symlink to path complete to <code class="text-violet-600 dark:text-violet-400">/bin</code>. Since this is (or can be?) a symlink to
<code>/usr/bin</code>, it was not marked as a directory and therefore did not <code class="text-violet-600 dark:text-violet-400">/usr/bin</code>, it was not marked as a directory and therefore did not
automatically add the ending slash. This has been fixed.</h2><h2 class="font-bold text-3xl" id="Segfaults-I-found-that-when-I-updated-my-terminal-of-choice-([Tym])-for-the-new-daemon-feature-Hilbish-would-sometimes-segfault-on-startup.-This-is-due-to-it-getting-a-resize-event-on-startup-while-bait-was-not-initialized-yet.">Segfaults automatically add the ending slash. This has been fixed.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Segfaults-I-found-that-when-I-updated-my-terminal-of-choice-([Tym])-for-the-new-daemon-feature-Hilbish-would-sometimes-segfault-on-startup.-This-is-due-to-it-getting-a-resize-event-on-startup-while-bait-was-not-initialized-yet.">Segfaults
I found that when I updated my terminal of choice ([Tym]) for the new I found that when I updated my terminal of choice ([Tym]) for the new
daemon feature, Hilbish would sometimes segfault on startup. This is due daemon feature, Hilbish would sometimes segfault on startup. This is due
to it getting a resize event on startup while <code>bait</code> was not initialized to it getting a resize event on startup while <code class="text-violet-600 dark:text-violet-400">bait</code> was not initialized
yet.</h2><h2 class="font-bold text-3xl" id="API-Fixes---The-hilbish.which-function-works-with-aliases.---hilbish.completion.files-and-hilbish.completion.bins-will-no-longer-cause-a-panic-with-all-empty-arguments-passed.">API Fixes yet.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="API-Fixes---The-hilbish.which-function-works-with-aliases.---hilbish.completion.files-and-hilbish.completion.bins-will-no-longer-cause-a-panic-with-all-empty-arguments-passed.">API Fixes
- The <code>hilbish.which</code> function works with aliases. - The <code class="text-violet-600 dark:text-violet-400">hilbish.which</code> function works with aliases.
- <code>hilbish.completion.files</code> and <code>hilbish.completion.bins</code> will no longer - <code class="text-violet-600 dark:text-violet-400">hilbish.completion.files</code> and <code class="text-violet-600 dark:text-violet-400">hilbish.completion.bins</code> will no longer
cause a panic with all empty arguments passed.</h2><h1 class="font-bold text-4xl" id="Next-Release-Stay-tuned-for-the-v2.2-release-which-will-have-a-bigger-set-of-features-and-maybe-some-more-bug-fixes">Next Release cause a panic with all empty arguments passed.</h2><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Next-Release-Stay-tuned-for-the-v2.2-release-which-will-have-a-bigger-set-of-features-and-maybe-some-more-bug-fixes">Next Release
Stay tuned for the v2.2 release, which will have a bigger set of features Stay tuned for the v2.2 release, which will have a bigger set of features
and maybe some more bug fixes!</h1></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> and maybe some more bug fixes!</h1></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="http://localhost:9080"><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>

16
versions/new-website/blog/v2.1.1-release/index.html
View File

@ -1,18 +1,18 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>v2.1.1 Release</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">v2.1.1 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>v2.1.1 Release</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">v2.1.1 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be
seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.1.1">v2.1.1</a> seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.1.1">v2.1.1</a>
tag.</p><p>Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting tag.</p><p>Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting
the long coming v2.2 release with lots of features, but I <strong>needed</strong> to push the long coming v2.2 release with lots of features, but I <strong>needed</strong> to push
out this little bug fix (wink) release.</p><h1 class="font-bold text-4xl" id="Bug-Fixes">Bug Fixes</h1><h2 class="font-bold text-3xl" id="Validation-checks-for-command-input-When-running-this-version-you-may-have-noticed-an-odd-message-that-sometimes-comes-up-when-running-commands.-This-is-from-the-new-TMOLI42SH-(The-Meaning-of-Life-is-42-String-Hash)-input-validation-scheme.">Validation checks for command input out this little bug fix (wink) release.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Bug-Fixes">Bug Fixes</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Validation-checks-for-command-input-When-running-this-version-you-may-have-noticed-an-odd-message-that-sometimes-comes-up-when-running-commands.-This-is-from-the-new-TMOLI42SH-(The-Meaning-of-Life-is-42-String-Hash)-input-validation-scheme.">Validation checks for command input
When running this version, you may have noticed an odd message that sometimes When running this version, you may have noticed an odd message that sometimes
comes up when running commands. This is from the new TMOLI42SH comes up when running commands. This is from the new TMOLI42SH
(The Meaning of Life is 42 String Hash) input validation scheme.</h2><h2 class="font-bold text-3xl" id="Improved-runtime-code-Commands-now-have-a-chance-of-taking-exactly-2-3s-~~more~~-less-time-of-running-due-to-improvements-in-the-code-for-shell-runners">Improved runtime code (The Meaning of Life is 42 String Hash) input validation scheme.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Improved-runtime-code-Commands-now-have-a-chance-of-taking-exactly-2-3s-~~more~~-less-time-of-running-due-to-improvements-in-the-code-for-shell-runners">Improved runtime code
Commands now have a chance of taking exactly 2-3s ~~more~~ less time of running due to Commands now have a chance of taking exactly 2-3s ~~more~~ less time of running due to
improvements in the code for shell runners!!!!!</h2><h2 class="font-bold text-3xl" id="Validate-lua-code-Hilbish-already-threw-an-error-when-Lua-code-was-not-valid-in-syntax-but-there-was-the-need-for-an-extra-validation-scheme-(called-OpTTCLC---Opinion-based-Turing-Test-to-Check-Lua-Code)-which-results-in-less-time-wasted-running-invalid-and-TERRIBLE-Lua-code.">Validate lua code improvements in the code for shell runners!!!!!</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Validate-lua-code-Hilbish-already-threw-an-error-when-Lua-code-was-not-valid-in-syntax-but-there-was-the-need-for-an-extra-validation-scheme-(called-OpTTCLC---Opinion-based-Turing-Test-to-Check-Lua-Code)-which-results-in-less-time-wasted-running-invalid-and-TERRIBLE-Lua-code.">Validate lua code
Hilbish already threw an error when Lua code was not valid in syntax, but there was the Hilbish already threw an error when Lua code was not valid in syntax, but there was the
need for an extra validation scheme (called OpTTCLC - Opinion based Turing Test to Check Lua Code) need for an extra validation scheme (called OpTTCLC - Opinion based Turing Test to Check Lua Code)
which results in less time wasted running invalid and TERRIBLE Lua code.</h2><h1 class="font-bold text-4xl" id="Features-There-is-only-1-new-feature-in-this-glorious-release.">Features which results in less time wasted running invalid and TERRIBLE Lua code.</h2><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Features-There-is-only-1-new-feature-in-this-glorious-release.">Features
There is only 1 new feature in this glorious release.</h1><h2 class="font-bold text-3xl" id="Fix-your-mistakes-for-the-future-If-you-run-a-command-that-does-not-exist-Hilbish-will-say-goodbye.">Fix your mistakes for the future There is only 1 new feature in this glorious release.</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Fix-your-mistakes-for-the-future-If-you-run-a-command-that-does-not-exist-Hilbish-will-say-goodbye.">Fix your mistakes for the future
If you run a command that does not exist, Hilbish will say goodbye.</h2><h1 class="font-bold text-4xl" id="Closing-Hope-you-enjoy-this-new-release-It-took-a-lot-of-effort-to-create-this-new-version-while-I-was-busy-doing-completely-nothing.-:)))">Closing If you run a command that does not exist, Hilbish will say goodbye.</h2><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Closing-Hope-you-enjoy-this-new-release-It-took-a-lot-of-effort-to-create-this-new-version-while-I-was-busy-doing-completely-nothing.-:)))">Closing
Hope you enjoy this new release! It took a lot of effort to create this new version Hope you enjoy this new release! It took a lot of effort to create this new version
while I was busy doing completely nothing. :)))</h1></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> while I was busy doing completely nothing. :)))</h1></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="http://localhost:9080"><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>

4
versions/new-website/blog/v2.1.2-release/index.html
View File

@ -1,6 +1,6 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>v2.1.2 Release</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">v2.1.2 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>v2.1.2 Release</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">v2.1.2 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be
seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.1.2">v2.1.2</a> seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.1.2">v2.1.2</a>
tag.</p><p>This release reverts the April Fool&#39;s code additions in v2.1.1. It is tag.</p><p>This release reverts the April Fool&#39;s code additions in v2.1.1. It is
functionally equal to v2.1.0. Nice!</p><p>A real release will come possibly in a few days or next week, so stay tuned for functionally equal to v2.1.0. Nice!</p><p>A real release will come possibly in a few days or next week, so stay tuned for
the good and feature-filled release of v2.2!</p></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> the good and feature-filled release of v2.2!</p></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="http://localhost:9080"><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>

32
versions/new-website/blog/v2.2-release/index.html
View File

@ -1,37 +1,37 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>v2.2 Release</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">v2.2 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>v2.2 Release</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">v2.2 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be
seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.2.0">v2.2.0</a> seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.2.0">v2.2.0</a>
tag.</p><p>Welcome to a very long awaited release of Hilbish, and on Christmas. Just think tag.</p><p>Welcome to a very long awaited release of Hilbish, and on Christmas. Just think
of it as a long preparing, late Christmas gift. :) of it as a long preparing, late Christmas gift. :)
This release does not contain a whole lot of changes, but it is a new This release does not contain a whole lot of changes, but it is a new
release with enhancements and bug fixes!</p><h1 class="font-bold text-4xl" id="Documentation-As-is-a-trend-the-documentation-has-been-improved-by-ONE-HUNDRED-TIMES.-Okay-not-quite-but-they&#39;ve-definitely-been-given-an-uplift.-Everything-has-been-rewritten-new-documentation-has-been-added-to-both-the-website-and-the-local-docs-accessible-with-the-doc-command.-Both-the-website-and-local-docs-are-now-in-sync-with-each-other.">Documentation release with enhancements and bug fixes!</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Documentation-As-is-a-trend-the-documentation-has-been-improved-by-ONE-HUNDRED-TIMES.-Okay-not-quite-but-they&#39;ve-definitely-been-given-an-uplift.-Everything-has-been-rewritten-new-documentation-has-been-added-to-both-the-website-and-the-local-docs-accessible-with-the-doc-command.-Both-the-website-and-local-docs-are-now-in-sync-with-each-other.">Documentation
As is a trend, the documentation has been improved by ONE HUNDRED TIMES. As is a trend, the documentation has been improved by ONE HUNDRED TIMES.
Okay, not quite, but they&#39;ve definitely been given an uplift. Okay, not quite, but they&#39;ve definitely been given an uplift.
Everything has been rewritten, new documentation has been added to both Everything has been rewritten, new documentation has been added to both
the website and the local docs accessible with the <code>doc</code> command. the website and the local docs accessible with the <code class="text-violet-600 dark:text-violet-400">doc</code> command.
Both the website and local docs are now in sync with each other.</h1><p>This means that the <code>doc</code> command has also been improved to consolidate Both the website and local docs are now in sync with each other.</h1><p>This means that the <code class="text-violet-600 dark:text-violet-400">doc</code> command has also been improved to consolidate
the documentation changes. It looks a lot better, has pagination, etc!</p><p>Speaking of pagination... the documentation changes. It looks a lot better, has pagination, etc!</p><p>Speaking of pagination...
# Features # Features
## Greenhouse ## Greenhouse
The first new added feature is the Greenhouse pager! It is a library and The first new added feature is the Greenhouse pager! It is a library and
command accessible via <code>greenhouse</code>. It will have better integration with command accessible via <code class="text-violet-600 dark:text-violet-400">greenhouse</code>. It will have better integration with
Hilbish things, like notifications and can be used as a base for displaying Hilbish things, like notifications and can be used as a base for displaying
multi-line text output instead of paging to less. The usage of Greenhouse is multi-line text output instead of paging to less. The usage of Greenhouse is
more efficient and better in Hibish!</p><h2 class="font-bold text-3xl" id="Notifications-Wait...-notifications-Yes-All-new-in-the-2.2-release-is-a-generic-notification-interface-for-things-in-Hilbish-to-alert-the-user-of-things-going-on.-Stuff-like-background-jobs-finishing-simple-alarms-actual-messages-whatever-you-like.">Notifications more efficient and better in Hibish!</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Notifications-Wait...-notifications-Yes-All-new-in-the-2.2-release-is-a-generic-notification-interface-for-things-in-Hilbish-to-alert-the-user-of-things-going-on.-Stuff-like-background-jobs-finishing-simple-alarms-actual-messages-whatever-you-like.">Notifications
Wait... notifications? Yes! All new in the 2.2 release is a generic notification Wait... notifications? Yes! All new in the 2.2 release is a generic notification
interface for things in Hilbish to alert the user of things going on. Stuff like interface for things in Hilbish to alert the user of things going on. Stuff like
background jobs finishing, simple alarms, <strong>actual messages</strong>, whatever you like.</h2><h2 class="font-bold text-3xl" id="Fuzzy-Searching-Users-can-now-use-fuzzy-search-for-command-history-and-completion-search.-Enable-it-with-hilbish.opts.fuzzy-=-true">Fuzzy Searching background jobs finishing, simple alarms, <strong>actual messages</strong>, whatever you like.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Fuzzy-Searching-Users-can-now-use-fuzzy-search-for-command-history-and-completion-search.-Enable-it-with-hilbish.opts.fuzzy-=-true">Fuzzy Searching
Users can now use fuzzy search for command history and completion search. Users can now use fuzzy search for command history and completion search.
Enable it with <code>hilbish.opts.fuzzy = true</code>!</h2><h3 class="font-bold text-2xl" id="Smaller-Enhancements-Did-you-know-of-the-cdr-command-I-personally-don&#39;t-use-it-but-I&#39;ve-made-it-look-slightly-better-for-ease-of-use.-That-simple-change-is-adding-the-indexes-next-to-the-directory-so-you&#39;ll-know-to-type-cdr-2.">Smaller Enhancements Enable it with <code class="text-violet-600 dark:text-violet-400">hilbish.opts.fuzzy = true</code>!</h2><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="Smaller-Enhancements-Did-you-know-of-the-cdr-command-I-personally-don&#39;t-use-it-but-I&#39;ve-made-it-look-slightly-better-for-ease-of-use.-That-simple-change-is-adding-the-indexes-next-to-the-directory-so-you&#39;ll-know-to-type-cdr-2.">Smaller Enhancements
Did you know of the <code>cdr</code> command? I personally don&#39;t use it, but I&#39;ve made Did you know of the <code class="text-violet-600 dark:text-violet-400">cdr</code> command? I personally don&#39;t use it, but I&#39;ve made
it look slightly better for ease of use. That simple change is adding the indexes it look slightly better for ease of use. That simple change is adding the indexes
next to the directory so you&#39;ll know to type <code>cdr 2</code>.</h3><p>Users can now add aliases with numbered substitutions. In shell script, next to the directory so you&#39;ll know to type <code class="text-violet-600 dark:text-violet-400">cdr 2</code>.</h3><p>Users can now add aliases with numbered substitutions. In shell script,
some people have to make functions for certain things that are actually some people have to make functions for certain things that are actually
just aliases. A simple example: <code>nix run nixpkgs#package</code> cannot be aliased just aliases. A simple example: <code class="text-violet-600 dark:text-violet-400">nix run nixpkgs#package</code> cannot be aliased
because if it was aliased to something like <code>run</code> normally there would be a space after.</p><p>Simple fix: because if it was aliased to something like <code class="text-violet-600 dark:text-violet-400">run</code> normally there would be a space after.</p><p>Simple fix:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
hilbish.alias(&#39;run&#39;, &#39;nix run nixpkgs#%1&#39;) hilbish.alias(&#39;run&#39;, &#39;nix run nixpkgs#%1&#39;)
</code></p><p>Rejoice!</p><h1 class="font-bold text-4xl" id="Bug-Fixes-There-are-a-small-amount-of-bug-fixes-but-they&#39;re-still-fixes">Bug Fixes </code></p><p>Rejoice!</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Bug-Fixes-There-are-a-small-amount-of-bug-fixes-but-they&#39;re-still-fixes">Bug Fixes
There are a small amount of bug fixes but they&#39;re still fixes!</h1><p>In some cases Hilbish will panic if: There are a small amount of bug fixes but they&#39;re still fixes!</h1><p>In some cases Hilbish will panic if:
- Alias resolution results in something empty - Alias resolution results in something empty
- A user does not return a table in a runner functions - A user does not return a table in a runner functions
@ -39,8 +39,8 @@ These are both fixed.</p><p>An infinite loop has been patched out if someone nav
having any prior history. Imagine pressing the up key on a fresh Hilbish having any prior history. Imagine pressing the up key on a fresh Hilbish
install and you shell no longer working... that&#39;s gone now.</p><p>Something else that&#39;s gone... is still Windows support, but I added a fix install and you shell no longer working... that&#39;s gone now.</p><p>Something else that&#39;s gone... is still Windows support, but I added a fix
which will make file completion work now. Job management commands work as which will make file completion work now. Job management commands work as
well now too due to an oversight when changing up the job functions.</p><h1 class="font-bold text-4xl" id="Towards-v2.3-For-the-next-release-I&#39;m-hoping-that-it-won&#39;t-take-as-long-to-deliver-on-what-is-realistically-a-small-amount-of-changes.-So-v2.3-will-be-coming-in-a-short-time-with-some-good-changes-promise-See-you-in-the-next-blog-post.">Towards v2.3 well now too due to an oversight when changing up the job functions.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Towards-v2.3-For-the-next-release-I&#39;m-hoping-that-it-won&#39;t-take-as-long-to-deliver-on-what-is-realistically-a-small-amount-of-changes.-So-v2.3-will-be-coming-in-a-short-time-with-some-good-changes-promise-See-you-in-the-next-blog-post.">Towards v2.3
For the next release, I&#39;m hoping that it won&#39;t take as long to deliver on For the next release, I&#39;m hoping that it won&#39;t take as long to deliver on
what is realistically a small amount of changes. So v2.3 will be coming what is realistically a small amount of changes. So v2.3 will be coming
in a short time with some good changes, promise! See you in the in a short time with some good changes, promise! See you in the
next blog post.</h1></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> next blog post.</h1></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="http://localhost:9080"><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>

16
versions/new-website/blog/v2.3-release/index.html
View File

@ -1,14 +1,14 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>v2.3 Release</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">v2.3 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>v2.3 Release</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">v2.3 Release</h1><p>&gt; The release with full changelogs and prebuilt binaries can be
seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.3.0">v2.3.0</a> seen at the <a href="https://github.com/Rosettea/Hilbish/releases/tag/v2.3.0">v2.3.0</a>
tag.</p><p>Hilbish v2.3 has now been released! This is small feature and bug fix release tag.</p><p>Hilbish v2.3 has now been released! This is small feature and bug fix release
which took a while to cme ut since I took a long break from programming in general. which took a while to cme ut since I took a long break from programming in general.
The next release will be great, so stay tuned for that.</p><h1 class="font-bold text-4xl" id="Features">Features</h1><h2 class="font-bold text-3xl" id="Pipes-(via-Lua)-Commands-can-now-be-piped-to-each-other-via-the-Lua-API-with-the-hilbish.run-function-and-an-fs.pipe.">Pipes (via Lua) The next release will be great, so stay tuned for that.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Features">Features</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Pipes-(via-Lua)-Commands-can-now-be-piped-to-each-other-via-the-Lua-API-with-the-hilbish.run-function-and-an-fs.pipe.">Pipes (via Lua)
Commands can now be piped to each other via the Lua API with the <code>hilbish.run</code> Commands can now be piped to each other via the Lua API with the <code class="text-violet-600 dark:text-violet-400">hilbish.run</code>
function and an <code>fs.pipe</code>.</h2><p>Here is a minimal example of the new usage which allows users to now pipe commands function and an <code class="text-violet-600 dark:text-violet-400">fs.pipe</code>.</h2><p>Here is a minimal example of the new usage which allows users to now pipe commands
directly via Lua functions: directly via Lua functions:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
local fs = require &#39;fs&#39; local fs = require &#39;fs&#39;
local pr, pw = fs.pipe() local pr, pw = fs.pipe()
hilbish.run(&#39;ls -l&#39;, { hilbish.run(&#39;ls -l&#39;, {
@ -17,11 +17,11 @@ hilbish.run(&#39;ls -l&#39;, {
})</code></p><p>pw:close()</p><p>hilbish.run(&#39;wc -l&#39;, { })</code></p><p>pw:close()</p><p>hilbish.run(&#39;wc -l&#39;, {
stdin = pr stdin = pr
}) })
<code></code></p><p>This also means it&#39;s easier to make commands output to any stream output, <code class="text-violet-600 dark:text-violet-400"></code></p><p>This also means it&#39;s easier to make commands output to any stream output,
including in commanders.</p><h1 class="font-bold text-4xl" id="Bug-Fixes---Commanders-can-now-be-cancelled-with-Ctrl-C-which-means-if-they-froze-for-some-reason-they-can-now-be-exited.---The-shell-script-interpreter-now-keeps-its-environment-and-this-also-fixes-the-current-working-directory-being-wrong-with-some-commands.---Some-greenhouse-bugs-have-been-fixed-like-randomly-appearing-when-resizing-the-terminal-and-some-text-attributes-like-color-appearing-where-they-weren&#39;t-supposed-to.">Bug Fixes including in commanders.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Bug-Fixes---Commanders-can-now-be-cancelled-with-Ctrl-C-which-means-if-they-froze-for-some-reason-they-can-now-be-exited.---The-shell-script-interpreter-now-keeps-its-environment-and-this-also-fixes-the-current-working-directory-being-wrong-with-some-commands.---Some-greenhouse-bugs-have-been-fixed-like-randomly-appearing-when-resizing-the-terminal-and-some-text-attributes-like-color-appearing-where-they-weren&#39;t-supposed-to.">Bug Fixes
- Commanders can now be cancelled with Ctrl-C, which means if they froze for some reason - Commanders can now be cancelled with Ctrl-C, which means if they froze for some reason
they can now be exited. they can now be exited.
- The shell script interpreter now keeps its environment, and this also fixes the - The shell script interpreter now keeps its environment, and this also fixes the
current working directory being wrong with some commands. current working directory being wrong with some commands.
- Some greenhouse bugs have been fixed, like randomly appearing when resizing the terminal - Some greenhouse bugs have been fixed, like randomly appearing when resizing the terminal
and some text attributes like color appearing where they weren&#39;t supposed to.</h1></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> and some text attributes like color appearing where they weren&#39;t supposed to.</h1></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="http://localhost:9080"><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>

4
versions/new-website/blog/welcome/index.html
View File

@ -1,3 +1,3 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Welcome to the Hilbish blog</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Welcome to the Hilbish blog</h1><p>Hello! Welcome to the Hilbish blog. This will mainly contain release <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Welcome to the Hilbish blog</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Welcome to the Hilbish blog</h1><p>Hello! Welcome to the Hilbish blog. This will mainly contain release
announcements and some other things relating to Hilbish (development).</p></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> announcements and some other things relating to Hilbish (development).</p></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="http://localhost:9080"><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>

3
versions/new-website/do/index.html Normal file
View File

@ -0,0 +1,3 @@
<!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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>API</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">API</h1><p>Welcome to the API documentation for Hilbish. This documents Lua functions
provided by Hilbish.</p></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="http://localhost:9080"><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>

154
versions/new-website/docs/api/bait/index.html
View File

@ -1,94 +1,104 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module bait</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module bait</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>Bait is the event emitter for Hilbish. Much like Node.js and <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module bait</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module bait</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>Bait is the event emitter for Hilbish. Much like Node.js and
its <code>events</code> system, many actions in Hilbish emit events. its <code class="text-violet-600 dark:text-violet-400">events</code> system, many actions in Hilbish emit events.
Unlike Node.js, Hilbish events are global. So make sure to Unlike Node.js, Hilbish events are global. So make sure to
pick a unique name!</p><p>Usage of the Bait module consists of userstanding pick a unique name!</p><p>Usage of the Bait module consists of userstanding
event-driven architecture, but it&#39;s pretty simple: event-driven architecture, but it&#39;s pretty simple:
If you want to act on a certain event, you can <code>catch</code> it. If you want to act on a certain event, you can <code class="text-violet-600 dark:text-violet-400">catch</code> it.
You can act on events via callback functions.</p><p>Examples of this are in the Hilbish default config! You can act on events via callback functions.</p><p>Examples of this are in the Hilbish default config!
Consider this part of it: Consider this part of it:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
bait.catch(&#39;command.exit&#39;, function(code) bait.catch(&#39;command.exit&#39;, function(code)
running = false running = false
doPrompt(code ~= 0) doPrompt(code ~= 0)
doNotifyPrompt() doNotifyPrompt()
end) end)
</code></p><p>What this does is, whenever the <code>command.exit</code> event is thrown, </code></p><p>What this does is, whenever the <code class="text-violet-600 dark:text-violet-400">command.exit</code> event is thrown,
this function will set the user prompt.</p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;catch&quot;&gt;catch(name-cb)&lt;/a&gt;|Catches-an-event.-This-function-can-be-used-to-act-on-events.|-|&lt;a-href=&quot;catchOnce&quot;&gt;catchOnce(name-cb)&lt;/a&gt;|Catches-an-event-but-only-once.-This-will-remove-the-hook-immediately-after-it-runs-for-the-first-time.|-|&lt;a-href=&quot;hooks&quot;&gt;hooks(name)--&gt;-table&lt;/a&gt;|Returns-a-table-of-functions-that-are-hooked-on-an-event-with-the-corresponding-name.|-|&lt;a-href=&quot;release&quot;&gt;release(name-catcher)&lt;/a&gt;|Removes-the-catcher-for-the-event-with-name.|-|&lt;a-href=&quot;throw&quot;&gt;throw(name-...args)&lt;/a&gt;|Throws-a-hook-with-name-with-the-provided-args.|">Functions this function will set the user prompt.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
||| <table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
|----|----| <tbody>
|&lt;a href=&quot;#catch&quot;&gt;catch(name, cb)&lt;/a&gt;|Catches an event. This function can be used to act on events.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#catchOnce&quot;&gt;catchOnce(name, cb)&lt;/a&gt;|Catches an event, but only once. This will remove the hook immediately after it runs for the first time.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#catch">catch(name, cb)</a></td>
|&lt;a href=&quot;#hooks&quot;&gt;hooks(name) -&gt; table&lt;/a&gt;|Returns a table of functions that are hooked on an event with the corresponding <code>name</code>.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Catches an event. This function can be used to act on events.</td>
|&lt;a href=&quot;#release&quot;&gt;release(name, catcher)&lt;/a&gt;|Removes the <code>catcher</code> for the event with <code>name</code>.| </tr>
|&lt;a href=&quot;#throw&quot;&gt;throw(name, ...args)&lt;/a&gt;|Throws a hook with <code>name</code> with the provided <code>args</code>.|</h2><p>&lt;hr&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;div id=&#39;catch&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#catchOnce">catchOnce(name, cb)</a></td>
&lt;h4 class=&#39;heading&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Catches an event, but only once. This will remove the hook immediately after it runs for the first time.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#hooks">hooks(name) -> table</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns a table of functions that are hooked on an event with the corresponding `name`.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#release">release(name, catcher)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Removes the `catcher` for the event with `name`.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#throw">throw(name, ...args)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Throws a hook with `name` with the provided `args`.</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='catch'>
<h4 class='text-xl font-medium mb-2'>
bait.catch(name, cb) bait.catch(name, cb)
&lt;a href=&quot;#catch&quot; class=&#39;heading-link&#39;&gt; <a href="#catch" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Catches an event. This function can be used to act on events. </p><p class="font-bold text-xl" id="Parameters-string-**name**---The-name-of-the-hook.">Parameters </h4></div><p>Catches an event. This function can be used to act on events. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** The name of the hook.</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*cb*</code>
The name of the hook.</p><p><code>function</code> **<code>cb</code>** The function that will be called when the hook is thrown.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Example">Example</p><pre><code data-lang="lua">bait.catch(&#39;hilbish.exit&#39;, function()
The function that will be called when the hook is thrown.</p><p class="font-bold text-xl" id="Example-lua-bait.catch(&#39;hilbish.exit&#39;-function()- print-&#39;Goodbye-Hilbish&#39;-end)--&lt;/div&gt;">Example
<code>lua
bait.catch(&#39;hilbish.exit&#39;, function()
print &#39;Goodbye Hilbish!&#39; print &#39;Goodbye Hilbish!&#39;
end) end)
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='catchOnce'>
&lt;div id=&#39;catchOnce&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
bait.catchOnce(name, cb) bait.catchOnce(name, cb)
&lt;a href=&quot;#catchOnce&quot; class=&#39;heading-link&#39;&gt; <a href="#catchOnce" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Catches an event, but only once. This will remove the hook immediately after it runs for the first time. </p><p class="font-bold text-xl" id="Parameters-string-**name**---The-name-of-the-event">Parameters </h4></div><p>Catches an event, but only once. This will remove the hook immediately after it runs for the first time. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** The name of the event</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*cb*</code>
The name of the event</p><p><code>function</code> **<code>cb</code>** The function that will be called when the event is thrown.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
The function that will be called when the event is thrown.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='hooks'>
&lt;div id=&#39;hooks&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; bait.hooks(name) -> table
bait.hooks(name) -&gt; table <a href="#hooks" class='heading-link'>
&lt;a href=&quot;#hooks&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Returns a table of functions that are hooked on an event with the corresponding <code class="text-violet-600 dark:text-violet-400">name</code>. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
&lt;/h4&gt;</p><p>Returns a table of functions that are hooked on an event with the corresponding <code>name</code>. </p><p class="font-bold text-xl" id="Parameters-string-**name**---The-name-of-the-hook">Parameters The name of the hook</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>string</code> **<code>name</code>** <div id='release'>
The name of the hook</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;release&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
bait.release(name, catcher) bait.release(name, catcher)
&lt;a href=&quot;#release&quot; class=&#39;heading-link&#39;&gt; <a href="#release" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Removes the <code>catcher</code> for the event with <code>name</code>. </h4></div><p>Removes the <code class="text-violet-600 dark:text-violet-400">catcher</code> for the event with <code class="text-violet-600 dark:text-violet-400">name</code>.
For this to work, <code>catcher</code> has to be the same function used to catch For this to work, <code class="text-violet-600 dark:text-violet-400">catcher</code> has to be the same function used to catch
an event, like one saved to a variable. </p><p class="font-bold text-xl" id="Parameters-string-**name**---Name-of-the-event-the-hook-is-on">Parameters an event, like one saved to a variable. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** Name of the event the hook is on</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*catcher*</code>
Name of the event the hook is on</p><p><code>function</code> **<code>catcher</code>** Hook function to remove</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">local hookCallback = function() print &#39;hi&#39; end
Hook function to remove</p><p class="font-bold text-xl" id="Example-lua-local-hookCallback-=-function()-print-&#39;hi&#39;-end">Example
<code>lua bait.catch(&#39;event&#39;, hookCallback)
local hookCallback = function() print &#39;hi&#39; end</code></p><p>bait.catch(&#39;event&#39;, hookCallback)</p><p>-- a little while later....
-- a little while later....
bait.release(&#39;event&#39;, hookCallback) bait.release(&#39;event&#39;, hookCallback)
-- and now hookCallback will no longer be ran for the event. -- and now hookCallback will no longer be ran for the event.
<code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</code></p><p>&lt;hr&gt; <div id='throw'>
&lt;div id=&#39;throw&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
bait.throw(name, ...args) bait.throw(name, ...args)
&lt;a href=&quot;#throw&quot; class=&#39;heading-link&#39;&gt; <a href="#throw" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Throws a hook with <code>name</code> with the provided <code>args</code>. </p><p class="font-bold text-xl">Parameters </h4></div><p>Throws a hook with <code class="text-violet-600 dark:text-violet-400">name</code> with the provided <code class="text-violet-600 dark:text-violet-400">args</code>. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** The name of the hook.</p><p><code class="text-violet-600 dark:text-violet-400">any</code> <code class="text-violet-600 dark:text-violet-400">*args*</code> (This type is variadic. You can pass an infinite amount of parameters with this type.)
The name of the hook.</p><p><code>any</code> **<code>args</code>** (This type is variadic. You can pass an infinite amount of parameters with this type.) The arguments to pass to the hook.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">bait.throw(&#39;greeting&#39;, &#39;world&#39;)
The arguments to pass to the hook.</p><p class="font-bold text-xl" id="Example-lua-bait.throw(&#39;greeting&#39;-&#39;world&#39;)">Example
<code>lua -- This can then be listened to via
bait.throw(&#39;greeting&#39;, &#39;world&#39;)</code></p><p>-- This can then be listened to via
bait.catch(&#39;gretting&#39;, function(greetTo) bait.catch(&#39;gretting&#39;, function(greetTo)
print(&#39;Hello &#39; .. greetTo) print(&#39;Hello &#39; .. greetTo)
end) end)
<code> </code></pre></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="http://localhost:9080"><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>
&lt;/div&gt;</code></p></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>

105
versions/new-website/docs/api/commander/index.html
View File

@ -1,5 +1,5 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module commander</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module commander</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>Commander is the library which handles Hilbish commands. This makes <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module commander</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module commander</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>Commander is the library which handles Hilbish commands. This makes
the user able to add Lua-written commands to their shell without making the user able to add Lua-written commands to their shell without making
a separate script in a bin folder. Instead, you may simply use the Commander a separate script in a bin folder. Instead, you may simply use the Commander
library in your Hilbish config.</p><pre><code data-lang="lua">local commander = require &#39;commander&#39; library in your Hilbish config.</p><pre><code data-lang="lua">local commander = require &#39;commander&#39;
@ -7,58 +7,65 @@ library in your Hilbish config.</p><pre><code data-lang="lua">local commander =
commander.register(&#39;hello&#39;, function(args, sinks) commander.register(&#39;hello&#39;, function(args, sinks)
sinks.out:writeln &#39;Hello world!&#39; sinks.out:writeln &#39;Hello world!&#39;
end) end)
</code></pre><p>In this example, a command with the name of <code>hello</code> is created </code></pre><p>In this example, a command with the name of <code class="text-violet-600 dark:text-violet-400">hello</code> is created
that will print <code>Hello world!</code> to output. One question you may that will print <code class="text-violet-600 dark:text-violet-400">Hello world!</code> to output. One question you may
have is: What is the <code>sinks</code> parameter?</p><p>The <code>sinks</code> parameter is a table with 3 keys: <code>input</code>, <code>out</code>, and <code>err</code>. have is: What is the <code class="text-violet-600 dark:text-violet-400">sinks</code> parameter?</p><p>The <code class="text-violet-600 dark:text-violet-400">sinks</code> parameter is a table with 3 keys: <code class="text-violet-600 dark:text-violet-400">input</code>, <code class="text-violet-600 dark:text-violet-400">out</code>, and <code class="text-violet-600 dark:text-violet-400">err</code>.
There is an <code>in</code> alias to <code>input</code>, but it requires using the string accessor syntax (<code>sinks[&#39;in&#39;]</code>) There is an <code class="text-violet-600 dark:text-violet-400">in</code> alias to <code class="text-violet-600 dark:text-violet-400">input</code>, but it requires using the string accessor syntax (<code class="text-violet-600 dark:text-violet-400">sinks[&#39;in&#39;]</code>)
as <code>in</code> is also a Lua keyword, so <code>input</code> is preferred for use. as <code class="text-violet-600 dark:text-violet-400">in</code> is also a Lua keyword, so <code class="text-violet-600 dark:text-violet-400">input</code> is preferred for use.
All of them are a &lt;a href=&quot;/Hilbish/docs/api/hilbish/#sink&quot; style=&quot;text-decoration: none;&quot;&gt;Sink&lt;/a&gt;. All of them are a @Sink.
In the future, <code>sinks.in</code> will be removed.</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code>in</code> is the standard input.</p></li></ul><p>You may use the read functions on this sink to get input from the user. In the future, <code class="text-violet-600 dark:text-violet-400">sinks.in</code> will be removed.</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code class="text-violet-600 dark:text-violet-400">in</code> is the standard input.</p></li></ul><p>You may use the read functions on this sink to get input from the user.
- <code>out</code> is standard output. - <code class="text-violet-600 dark:text-violet-400">out</code> is standard output.
This is usually where command output should go. This is usually where command output should go.
- <code>err</code> is standard error. - <code class="text-violet-600 dark:text-violet-400">err</code> is standard error.
This sink is for writing errors, as the name would suggest.</p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;deregister&quot;&gt;deregister(name)&lt;/a&gt;|Removes-the-named-command.-Note-that-this-will-only-remove-Commander-registered-commands.|-|&lt;a-href=&quot;register&quot;&gt;register(name-cb)&lt;/a&gt;|Adds-a-new-command-with-the-given-name.-When-Hilbish-has-to-run-a-command-with-a-name|-|&lt;a-href=&quot;registry&quot;&gt;registry()--&gt;-table&lt;/a&gt;|Returns-all-registered-commanders.-Returns-a-list-of-tables-with-the-following-keys:|">Functions This sink is for writing errors, as the name would suggest.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
||| <table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
|----|----| <tbody>
|&lt;a href=&quot;#deregister&quot;&gt;deregister(name)&lt;/a&gt;|Removes the named command. Note that this will only remove Commander-registered commands.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#register&quot;&gt;register(name, cb)&lt;/a&gt;|Adds a new command with the given <code>name</code>. When Hilbish has to run a command with a name,| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#deregister">deregister(name)</a></td>
|&lt;a href=&quot;#registry&quot;&gt;registry() -&gt; table&lt;/a&gt;|Returns all registered commanders. Returns a list of tables with the following keys:|</h2><p>&lt;hr&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Removes the named command. Note that this will only remove Commander-registered commands.</td>
&lt;div id=&#39;deregister&#39;&gt; </tr>
&lt;h4 class=&#39;heading&#39;&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#register">register(name, cb)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Adds a new command with the given `name`. When Hilbish has to run a command with a name,</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#registry">registry() -> table</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns all registered commanders. Returns a list of tables with the following keys:</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='deregister'>
<h4 class='text-xl font-medium mb-2'>
commander.deregister(name) commander.deregister(name)
&lt;a href=&quot;#deregister&quot; class=&#39;heading-link&#39;&gt; <a href="#deregister" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Removes the named command. Note that this will only remove Commander-registered commands. </p><p class="font-bold text-xl" id="Parameters-string-**name**---Name-of-the-command-to-remove.">Parameters </h4></div><p>Removes the named command. Note that this will only remove Commander-registered commands. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** Name of the command to remove.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
Name of the command to remove.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='register'>
&lt;div id=&#39;register&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
commander.register(name, cb) commander.register(name, cb)
&lt;a href=&quot;#register&quot; class=&#39;heading-link&#39;&gt; <a href="#register" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Adds a new command with the given <code>name</code>. When Hilbish has to run a command with a name, </h4></div><p>Adds a new command with the given <code class="text-violet-600 dark:text-violet-400">name</code>. When Hilbish has to run a command with a name,
it will run the function providing the arguments and sinks. </p><p class="font-bold text-xl" id="Parameters-string-**name**---Name-of-the-command">Parameters it will run the function providing the arguments and sinks. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** Name of the command</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*cb*</code>
Name of the command</p><p><code>function</code> **<code>cb</code>** Callback to handle command invocation</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Example">Example</p><pre><code data-lang="lua">-- When you run the command `hello` in the shell, it will print `Hello world`.
Callback to handle command invocation</p><p class="font-bold text-xl" id="Example-lua----When-you-run-the-command-`hello`-in-the-shell-it-will-print-`Hello-world`.----If-you-run-it-with-for-example-`hello-Hilbish`-it-will-print-&#39;Hello-Hilbish&#39;-commander.register(&#39;hello&#39;-function(args-sinks)- local-name-=-&#39;world&#39;- if-args-&gt;-0-then-name-=-args[1]-end">Example
<code>lua
-- When you run the command `hello` in the shell, it will print `Hello world`.
-- If you run it with, for example, `hello Hilbish`, it will print &#39;Hello Hilbish&#39; -- If you run it with, for example, `hello Hilbish`, it will print &#39;Hello Hilbish&#39;
commander.register(&#39;hello&#39;, function(args, sinks) commander.register(&#39;hello&#39;, function(args, sinks)
local name = &#39;world&#39; local name = &#39;world&#39;
if #args &gt; 0 then name = args[1] end</code></p><p> sinks.out:writeln(&#39;Hello &#39; .. name) if #args &gt; 0 then name = args[1] end
sinks.out:writeln(&#39;Hello &#39; .. name)
end) end)
<code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</code></p><p>&lt;hr&gt; <div id='registry'>
&lt;div id=&#39;registry&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; commander.registry() -> table
commander.registry() -&gt; table <a href="#registry" class='heading-link'>
&lt;a href=&quot;#registry&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Returns all registered commanders. Returns a list of tables with the following keys:
&lt;/h4&gt;</p><p>Returns all registered commanders. Returns a list of tables with the following keys: - <code class="text-violet-600 dark:text-violet-400">exec</code>: The function used to run the commander. Commanders require args and sinks to be passed. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p>This function has no parameters. </p></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="http://localhost:9080"><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>
- <code>exec</code>: The function used to run the commander. Commanders require args and sinks to be passed. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters
This function has no parameters.
&lt;/div&gt;</p></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>

280
versions/new-website/docs/api/fs/index.html
View File

@ -1,72 +1,104 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module fs</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module fs</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>The fs module provides filesystem functions to Hilbish. While Lua&#39;s standard <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module fs</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module fs</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>The fs module provides filesystem functions to Hilbish. While Lua&#39;s standard
library has some I/O functions, they&#39;re missing a lot of the basics. The <code>fs</code> library has some I/O functions, they&#39;re missing a lot of the basics. The <code class="text-violet-600 dark:text-violet-400">fs</code>
library offers more functions and will work on any operating system Hilbish does.</p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;abs&quot;&gt;abs(path)--&gt;-string&lt;/a&gt;|Returns-an-absolute-version-of-the-path.|-|&lt;a-href=&quot;basename&quot;&gt;basename(path)--&gt;-string&lt;/a&gt;|Returns-the-&quot;basename&quot;-or-the-last-part-of-the-provided-path.-If-path-is-empty|-|&lt;a-href=&quot;cd&quot;&gt;cd(dir)&lt;/a&gt;|Changes-Hilbish&#39;s-directory-to-dir.|-|&lt;a-href=&quot;dir&quot;&gt;dir(path)--&gt;-string&lt;/a&gt;|Returns-the-directory-part-of-path.-If-a-file-path-like|-|&lt;a-href=&quot;glob&quot;&gt;glob(pattern)--&gt;-matches-(table)&lt;/a&gt;|Match-all-files-based-on-the-provided-pattern.|-|&lt;a-href=&quot;join&quot;&gt;join(...path)--&gt;-string&lt;/a&gt;|Takes-any-list-of-paths-and-joins-them-based-on-the-operating-system&#39;s-path-separator.|-|&lt;a-href=&quot;mkdir&quot;&gt;mkdir(name-recursive)&lt;/a&gt;|Creates-a-new-directory-with-the-provided-name.|-|&lt;a-href=&quot;pipe&quot;&gt;fpipe()--&gt;-File-File&lt;/a&gt;|Returns-a-pair-of-connected-files-also-known-as-a-pipe.|-|&lt;a-href=&quot;readdir&quot;&gt;readdir(path)--&gt;-table[string]&lt;/a&gt;|Returns-a-list-of-all-files-and-directories-in-the-provided-path.|-|&lt;a-href=&quot;stat&quot;&gt;stat(path)--&gt;-{}&lt;/a&gt;|Returns-the-information-about-a-given-path.|">Functions library offers more functions and will work on any operating system Hilbish does.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
||| <table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
|----|----| <tbody>
|&lt;a href=&quot;#abs&quot;&gt;abs(path) -&gt; string&lt;/a&gt;|Returns an absolute version of the <code>path</code>.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#basename&quot;&gt;basename(path) -&gt; string&lt;/a&gt;|Returns the &quot;basename,&quot; or the last part of the provided <code>path</code>. If path is empty,| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#abs">abs(path) -> string</a></td>
|&lt;a href=&quot;#cd&quot;&gt;cd(dir)&lt;/a&gt;|Changes Hilbish&#39;s directory to <code>dir</code>.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns an absolute version of the `path`.</td>
|&lt;a href=&quot;#dir&quot;&gt;dir(path) -&gt; string&lt;/a&gt;|Returns the directory part of <code>path</code>. If a file path like| </tr>
|&lt;a href=&quot;#glob&quot;&gt;glob(pattern) -&gt; matches (table)&lt;/a&gt;|Match all files based on the provided <code>pattern</code>.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#join&quot;&gt;join(...path) -&gt; string&lt;/a&gt;|Takes any list of paths and joins them based on the operating system&#39;s path separator.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#basename">basename(path) -> string</a></td>
|&lt;a href=&quot;#mkdir&quot;&gt;mkdir(name, recursive)&lt;/a&gt;|Creates a new directory with the provided <code>name</code>.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns the "basename," or the last part of the provided `path`. If path is empty,</td>
|&lt;a href=&quot;#pipe&quot;&gt;fpipe() -&gt; File, File&lt;/a&gt;|Returns a pair of connected files, also known as a pipe.| </tr>
|&lt;a href=&quot;#readdir&quot;&gt;readdir(path) -&gt; table[string]&lt;/a&gt;|Returns a list of all files and directories in the provided path.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#stat&quot;&gt;stat(path) -&gt; {}&lt;/a&gt;|Returns the information about a given <code>path</code>.|</h2><h2 class="font-bold text-3xl" id="Static-module-fields-|||-|----|----|-|pathSep|The-operating-system&#39;s-path-separator.|">Static module fields <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#cd">cd(dir)</a></td>
||| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Changes Hilbish's directory to `dir`.</td>
|----|----| </tr>
|pathSep|The operating system&#39;s path separator.|</h2><p>&lt;hr&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;div id=&#39;abs&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#dir">dir(path) -> string</a></td>
&lt;h4 class=&#39;heading&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns the directory part of `path`. If a file path like</td>
fs.abs(path) -&gt; string </tr>
&lt;a href=&quot;#abs&quot; class=&#39;heading-link&#39;&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#glob">glob(pattern) -> matches (table)</a></td>
&lt;/a&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Match all files based on the provided `pattern`.</td>
&lt;/h4&gt;</p><p>Returns an absolute version of the <code>path</code>. </tr>
This can be used to resolve short paths like <code>..</code> to <code>/home/user</code>. </p><p class="font-bold text-xl" id="Parameters-string-**path**">Parameters <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<code>string</code> **<code>path</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#join">join(...path) -> string</a></td>
&lt;div id=&#39;basename&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Takes any list of paths and joins them based on the operating system's path separator.</td>
&lt;h4 class=&#39;heading&#39;&gt; </tr>
fs.basename(path) -&gt; string <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;a href=&quot;#basename&quot; class=&#39;heading-link&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#mkdir">mkdir(name, recursive)</a></td>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Creates a new directory with the provided `name`.</td>
&lt;/a&gt; </tr>
&lt;/h4&gt;</p><p>Returns the &quot;basename,&quot; or the last part of the provided <code>path</code>. If path is empty, <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<code>.</code> will be returned. </p><p class="font-bold text-xl" id="Parameters-string-**path**---Path-to-get-the-base-name-of.">Parameters <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#pipe">fpipe() -> File, File</a></td>
<code>string</code> **<code>path</code>** <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns a pair of connected files, also known as a pipe.</td>
Path to get the base name of.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; </tr>
&lt;div id=&#39;cd&#39;&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;h4 class=&#39;heading&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#readdir">readdir(path) -> table[string]</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns a list of all files and directories in the provided path.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#stat">stat(path) -> {}</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns the information about a given `path`.</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Static-module-fields">Static module fields</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
<table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
<tbody>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>pathSep</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>The operating system's path separator.</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='abs'>
<h4 class='text-xl font-medium mb-2'>
fs.abs(path) -> string
<a href="#abs" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4></div><p>Returns an absolute version of the <code class="text-violet-600 dark:text-violet-400">path</code>.
This can be used to resolve short paths like <code class="text-violet-600 dark:text-violet-400">..</code> to <code class="text-violet-600 dark:text-violet-400">/home/user</code>. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*path*</code> </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='basename'>
<h4 class='text-xl font-medium mb-2'>
fs.basename(path) -> string
<a href="#basename" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4></div><p>Returns the &quot;basename,&quot; or the last part of the provided <code class="text-violet-600 dark:text-violet-400">path</code>. If path is empty,
<code class="text-violet-600 dark:text-violet-400">.</code> will be returned. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*path*</code>
Path to get the base name of.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='cd'>
<h4 class='text-xl font-medium mb-2'>
fs.cd(dir) fs.cd(dir)
&lt;a href=&quot;#cd&quot; class=&#39;heading-link&#39;&gt; <a href="#cd" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Changes Hilbish&#39;s directory to <code>dir</code>. </p><p class="font-bold text-xl" id="Parameters-string-**dir**---Path-to-change-directory-to.">Parameters </h4></div><p>Changes Hilbish&#39;s directory to <code class="text-violet-600 dark:text-violet-400">dir</code>. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*dir*</code>
<code>string</code> **<code>dir</code>** Path to change directory to.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
Path to change directory to.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='dir'>
&lt;div id=&#39;dir&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; fs.dir(path) -> string
fs.dir(path) -&gt; string <a href="#dir" class='heading-link'>
&lt;a href=&quot;#dir&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Returns the directory part of <code class="text-violet-600 dark:text-violet-400">path</code>. If a file path like
&lt;/h4&gt;</p><p>Returns the directory part of <code>path</code>. If a file path like <code class="text-violet-600 dark:text-violet-400">~/Documents/doc.txt</code> then this function will return <code class="text-violet-600 dark:text-violet-400">~/Documents</code>. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*path*</code>
<code>~/Documents/doc.txt</code> then this function will return <code>~/Documents</code>. </p><p class="font-bold text-xl" id="Parameters-string-**path**---Path-to-get-the-directory-for.">Parameters Path to get the directory for.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>string</code> **<code>path</code>** <div id='glob'>
Path to get the directory for.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;glob&#39;&gt; fs.glob(pattern) -> matches (table)
&lt;h4 class=&#39;heading&#39;&gt; <a href="#glob" class='heading-link'>
fs.glob(pattern) -&gt; matches (table) <i class="fas fa-paperclip"></i>
&lt;a href=&quot;#glob&quot; class=&#39;heading-link&#39;&gt; </a>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </h4></div><p>Match all files based on the provided <code class="text-violet-600 dark:text-violet-400">pattern</code>.
&lt;/a&gt; For the syntax&#39; refer to Go&#39;s filepath.Match function: https://pkg.go.dev/path/filepath#Match </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*pattern*</code>
&lt;/h4&gt;</p><p>Match all files based on the provided <code>pattern</code>. Pattern to compare files with.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Example">Example</p><pre><code data-lang="lua">--[[
For the syntax&#39; refer to Go&#39;s filepath.Match function: https://pkg.go.dev/path/filepath#Match </p><p class="font-bold text-xl" id="Parameters-string-**pattern**---Pattern-to-compare-files-with.">Parameters
<code>string</code> **<code>pattern</code>**
Pattern to compare files with.</p><p class="font-bold text-xl" id="Example-lua---[[- Within-a-folder-that-contains-the-following-files:- a.txt- init.lua- code.lua- doc.pdf-]]---local-matches-=-fs.glob-&#39;./*.lua&#39;-print(matches)-----&gt;-{&#39;init.lua&#39;-&#39;code.lua&#39;}--&lt;/div&gt;">Example
<code>lua
--[[
Within a folder that contains the following files: Within a folder that contains the following files:
a.txt a.txt
init.lua init.lua
@ -76,82 +108,68 @@ Pattern to compare files with.</p><p class="font-bold text-xl" id="Example-lua--
local matches = fs.glob &#39;./*.lua&#39; local matches = fs.glob &#39;./*.lua&#39;
print(matches) print(matches)
-- -&gt; {&#39;init.lua&#39;, &#39;code.lua&#39;} -- -&gt; {&#39;init.lua&#39;, &#39;code.lua&#39;}
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='join'>
&lt;div id=&#39;join&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; fs.join(...path) -> string
fs.join(...path) -&gt; string <a href="#join" class='heading-link'>
&lt;a href=&quot;#join&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Takes any list of paths and joins them based on the operating system&#39;s path separator. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*path*</code> (This type is variadic. You can pass an infinite amount of parameters with this type.)
&lt;/h4&gt;</p><p>Takes any list of paths and joins them based on the operating system&#39;s path separator. </p><p class="font-bold text-xl" id="Parameters-string-**path**-(This-type-is-variadic.-You-can-pass-an-infinite-amount-of-parameters-with-this-type.)---Paths-to-join-together">Parameters Paths to join together</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">-- This prints the directory for Hilbish&#39;s config!
<code>string</code> **<code>path</code>** (This type is variadic. You can pass an infinite amount of parameters with this type.)
Paths to join together</p><p class="font-bold text-xl" id="Example-lua----This-prints-the-directory-for-Hilbish&#39;s-config-print(fs.join(hilbish.userDir.config-&#39;hilbish&#39;))-----&gt;-&#39;/home/user/.config/hilbish&#39;-on-Linux--&lt;/div&gt;">Example
<code>lua
-- This prints the directory for Hilbish&#39;s config!
print(fs.join(hilbish.userDir.config, &#39;hilbish&#39;)) print(fs.join(hilbish.userDir.config, &#39;hilbish&#39;))
-- -&gt; &#39;/home/user/.config/hilbish&#39; on Linux -- -&gt; &#39;/home/user/.config/hilbish&#39; on Linux
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='mkdir'>
&lt;div id=&#39;mkdir&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
fs.mkdir(name, recursive) fs.mkdir(name, recursive)
&lt;a href=&quot;#mkdir&quot; class=&#39;heading-link&#39;&gt; <a href="#mkdir" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Creates a new directory with the provided <code>name</code>. </h4></div><p>Creates a new directory with the provided <code class="text-violet-600 dark:text-violet-400">name</code>.
With <code>recursive</code>, mkdir will create parent directories. </p><p class="font-bold text-xl" id="Parameters-string-**name**---Name-of-the-directory">Parameters With <code class="text-violet-600 dark:text-violet-400">recursive</code>, mkdir will create parent directories. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code>
<code>string</code> **<code>name</code>** Name of the directory</p><p><code class="text-violet-600 dark:text-violet-400">boolean</code> <code class="text-violet-600 dark:text-violet-400">*recursive*</code>
Name of the directory</p><p><code>boolean</code> **<code>recursive</code>** Whether to create parent directories for the provided name</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">-- This will create the directory foo, then create the directory bar in the
Whether to create parent directories for the provided name</p><p class="font-bold text-xl" id="Example-lua----This-will-create-the-directory-foo-then-create-the-directory-bar-in-the----foo-directory.-If-recursive-is-false-in-this-case-it-will-fail.-fs.mkdir(&#39;./foo/bar&#39;-true)--&lt;/div&gt;">Example
<code>lua
-- This will create the directory foo, then create the directory bar in the
-- foo directory. If recursive is false in this case, it will fail. -- foo directory. If recursive is false in this case, it will fail.
fs.mkdir(&#39;./foo/bar&#39;, true) fs.mkdir(&#39;./foo/bar&#39;, true)
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='pipe'>
&lt;div id=&#39;pipe&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; fs.fpipe() -> File, File
fs.fpipe() -&gt; File, File <a href="#pipe" class='heading-link'>
&lt;a href=&quot;#pipe&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Returns a pair of connected files, also known as a pipe.
&lt;/h4&gt;</p><p>Returns a pair of connected files, also known as a pipe. The type returned is a Lua file, same as returned from <code class="text-violet-600 dark:text-violet-400">io</code> functions. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p>This function has no parameters. </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
The type returned is a Lua file, same as returned from <code>io</code> functions. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters <div id='readdir'>
This function has no parameters. <h4 class='text-xl font-medium mb-2'>
&lt;/div&gt;</p><p>&lt;hr&gt; fs.readdir(path) -> table[string]
&lt;div id=&#39;readdir&#39;&gt; <a href="#readdir" class='heading-link'>
&lt;h4 class=&#39;heading&#39;&gt; <i class="fas fa-paperclip"></i>
fs.readdir(path) -&gt; table[string] </a>
&lt;a href=&quot;#readdir&quot; class=&#39;heading-link&#39;&gt; </h4></div><p>Returns a list of all files and directories in the provided path. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*dir*</code> </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <div id='stat'>
&lt;/a&gt; <h4 class='text-xl font-medium mb-2'>
&lt;/h4&gt;</p><p>Returns a list of all files and directories in the provided path. </p><p class="font-bold text-xl" id="Parameters-string-**dir**">Parameters fs.stat(path) -> {}
<code>string</code> **<code>dir</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <a href="#stat" class='heading-link'>
&lt;div id=&#39;stat&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;h4 class=&#39;heading&#39;&gt; </a>
fs.stat(path) -&gt; {} </h4></div><p>Returns the information about a given <code class="text-violet-600 dark:text-violet-400">path</code>.
&lt;a href=&quot;#stat&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the information about a given <code>path</code>.
The returned table contains the following values: The returned table contains the following values:
name (string) - Name of the path name (string) - Name of the path
size (number) - Size of the path in bytes size (number) - Size of the path in bytes
mode (string) - Unix permission mode in an octal format string (with leading 0) mode (string) - Unix permission mode in an octal format string (with leading 0)
isDir (boolean) - If the path is a directory </p><p class="font-bold text-xl">Parameters isDir (boolean) - If the path is a directory </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*path*</code> </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">local inspect = require &#39;inspect&#39;
<code>string</code> **<code>path</code>** </p><p class="font-bold text-xl" id="Example-lua-local-inspect-=-require-&#39;inspect&#39;">Example
<code>lua local stat = fs.stat &#39;~&#39;
local inspect = require &#39;inspect&#39;</code></p><p>local stat = fs.stat &#39;~&#39;
print(inspect(stat)) print(inspect(stat))
--[[ --[[
Would print the following: Would print the following:
{ {
isDir = true, isDir = true,
mode = &quot;0755&quot;, mode = &quot;0755&quot;,
name = &quot;username&quot;, name = &quot;username&quot;,
size = 12288 size = 12288
} }
]]-- ]]--
<code> </code></pre></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="http://localhost:9080"><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>
&lt;/div&gt;</code></p></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>

37
versions/new-website/docs/api/hilbish/hilbish.abbr/index.html
View File

@ -1,37 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.abbr</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.abbr</h1><h2 class="font-bold text-3xl" id="Introduction-The-abbr-module-manages-Hilbish-abbreviations.-These-are-words-that-can-be-replaced-with-longer-command-line-strings-when-entered.-As-an-example-git-push-can-be-abbreviated-to-gp.-When-the-user-types-gp-into-the-command-line-after-hitting-space-or-enter-it-will-expand-to-git-push.-Abbreviations-can-be-used-as-an-alternative-to-aliases.-They-are-saved-entirely-in-the-history-Instead-of-the-aliased-form-of-the-same-command.">Introduction
The abbr module manages Hilbish abbreviations. These are words that can be replaced
with longer command line strings when entered.
As an example, <code>git push</code> can be abbreviated to <code>gp</code>. When the user types
<code>gp</code> into the command line, after hitting space or enter, it will expand to <code>git push</code>.
Abbreviations can be used as an alternative to aliases. They are saved entirely in the history
Instead of the aliased form of the same command.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;remove&quot;&gt;remove(abbr)&lt;/a&gt;|Removes-the-named-abbr.|-|&lt;a-href=&quot;add&quot;&gt;add(abbr-expanded|function-opts)&lt;/a&gt;|Adds-an-abbreviation.-The-abbr-is-the-abbreviation-itself|-&lt;hr&gt;-&lt;div-id=&#39;add&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-hilbish.abbr.add(abbr-expanded|function-opts)-&lt;a-href=&quot;add&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions
|||
|----|----|
|&lt;a href=&quot;#remove&quot;&gt;remove(abbr)&lt;/a&gt;|Removes the named <code>abbr</code>.|
|&lt;a href=&quot;#add&quot;&gt;add(abbr, expanded|function, opts)&lt;/a&gt;|Adds an abbreviation. The <code>abbr</code> is the abbreviation itself,|
&lt;hr&gt;
&lt;div id=&#39;add&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.abbr.add(abbr, expanded|function, opts)
&lt;a href=&quot;#add&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</h2><p>Adds an abbreviation. The <code>abbr</code> is the abbreviation itself,
while <code>expanded</code> is what the abbreviation should expand to.
It can be either a function or a string. If it is a function, it will expand to what
the function returns.
<code>opts</code> is a table that accepts 1 key: <code>anywhere</code>.
<code>opts.anywhere</code> defines whether the abbr expands anywhere in the command line or not,
whereas the default behavior is only at the beginning of the line
#### Parameters
<code>abbr</code> **<code>string</code>** </p><p><code>expanded|function</code> **<code>string</code>** </p><p><code>opts</code> **<code>table</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;remove&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.abbr.remove(abbr)
&lt;a href=&quot;#remove&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Removes the named <code>abbr</code>.
#### Parameters
<code>abbr</code> **<code>string</code>** </p><p>&lt;/div&gt;</p></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>

48
versions/new-website/docs/api/hilbish/hilbish.aliases/index.html
View File

@ -1,48 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.aliases</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.aliases</h1><h2 class="font-bold text-3xl" id="Introduction-The-alias-interface-deals-with-all-command-aliases-in-Hilbish.">Introduction
The alias interface deals with all command aliases in Hilbish.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;aliases.add&quot;&gt;add(alias-cmd)&lt;/a&gt;|This-is-an-alias-(ha)-for-the-hilbish.alias-function.|-|&lt;a-href=&quot;aliases.delete&quot;&gt;delete(name)&lt;/a&gt;|Removes-an-alias.|-|&lt;a-href=&quot;aliases.list&quot;&gt;list()--&gt;-table[string-string]&lt;/a&gt;|Get-a-table-of-all-aliases-with-string-keys-as-the-alias-and-the-value-as-the-command.|-|&lt;a-href=&quot;aliases.resolve&quot;&gt;resolve(alias)--&gt;-string&lt;/a&gt;|Resolves-an-alias-to-its-original-command.-Will-thrown-an-error-if-the-alias-doesn&#39;t-exist.|">Functions
|||
|----|----|
|&lt;a href=&quot;#aliases.add&quot;&gt;add(alias, cmd)&lt;/a&gt;|This is an alias (ha) for the <a href="../#alias">hilbish.alias</a> function.|
|&lt;a href=&quot;#aliases.delete&quot;&gt;delete(name)&lt;/a&gt;|Removes an alias.|
|&lt;a href=&quot;#aliases.list&quot;&gt;list() -&gt; table[string, string]&lt;/a&gt;|Get a table of all aliases, with string keys as the alias and the value as the command.|
|&lt;a href=&quot;#aliases.resolve&quot;&gt;resolve(alias) -&gt; string?&lt;/a&gt;|Resolves an alias to its original command. Will thrown an error if the alias doesn&#39;t exist.|</h2><p>&lt;hr&gt;
&lt;div id=&#39;aliases.add&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.aliases.add(alias, cmd)
&lt;a href=&quot;#aliases.add&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>This is an alias (ha) for the <a href="../#alias">hilbish.alias</a> function. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;aliases.delete&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.aliases.delete(name)
&lt;a href=&quot;#aliases.delete&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Removes an alias. </p><p class="font-bold text-xl" id="Parameters-string-**name**">Parameters
<code>string</code> **<code>name</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;aliases.list&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.aliases.list() -&gt; table[string, string]
&lt;a href=&quot;#aliases.list&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Get a table of all aliases, with string keys as the alias and the value as the command. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---Example-lua-hilbish.aliases.add(&#39;hi&#39;-&#39;echo-hi&#39;)">Parameters
This function has no parameters.
Example
<code>lua
hilbish.aliases.add(&#39;hi&#39;, &#39;echo hi&#39;)</code></p><p>local aliases = hilbish.aliases.list()
-- -&gt; {hi = &#39;echo hi&#39;}
<code>
&lt;/div&gt;</code></p><p>&lt;hr&gt;
&lt;div id=&#39;aliases.resolve&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.aliases.resolve(alias) -&gt; string?
&lt;a href=&quot;#aliases.resolve&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Resolves an alias to its original command. Will thrown an error if the alias doesn&#39;t exist. </p><p class="font-bold text-xl" id="Parameters-string-**alias**">Parameters
<code>string</code> **<code>alias</code>** </p><p>&lt;/div&gt;</p></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>

74
versions/new-website/docs/api/hilbish/hilbish.completion/index.html
View File

@ -1,74 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.completion</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.completion</h1><h2 class="font-bold text-3xl" id="Introduction-The-completions-interface-deals-with-tab-completions.">Introduction
The completions interface deals with tab completions.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;completion.bins&quot;&gt;bins(query-ctx-fields)--&gt;-entries-(table)-prefix-(string)&lt;/a&gt;|Return-binaries/executables-based-on-the-provided-parameters.|-|&lt;a-href=&quot;completion.call&quot;&gt;call(name-query-ctx-fields)--&gt;-completionGroups-(table)-prefix-(string)&lt;/a&gt;|Calls-a-completer-function.-This-is-mainly-used-to-call-a-command-completer-which-will-have-a-name|-|&lt;a-href=&quot;completion.files&quot;&gt;files(query-ctx-fields)--&gt;-entries-(table)-prefix-(string)&lt;/a&gt;|Returns-file-matches-based-on-the-provided-parameters.|-|&lt;a-href=&quot;completion.handler&quot;&gt;handler(line-pos)&lt;/a&gt;|This-function-contains-the-general-completion-handler-for-Hilbish.-This-function-handles|">Functions
|||
|----|----|
|&lt;a href=&quot;#completion.bins&quot;&gt;bins(query, ctx, fields) -&gt; entries (table), prefix (string)&lt;/a&gt;|Return binaries/executables based on the provided parameters.|
|&lt;a href=&quot;#completion.call&quot;&gt;call(name, query, ctx, fields) -&gt; completionGroups (table), prefix (string)&lt;/a&gt;|Calls a completer function. This is mainly used to call a command completer, which will have a <code>name</code>|
|&lt;a href=&quot;#completion.files&quot;&gt;files(query, ctx, fields) -&gt; entries (table), prefix (string)&lt;/a&gt;|Returns file matches based on the provided parameters.|
|&lt;a href=&quot;#completion.handler&quot;&gt;handler(line, pos)&lt;/a&gt;|This function contains the general completion handler for Hilbish. This function handles|</h2><p>&lt;hr&gt;
&lt;div id=&#39;completion.bins&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.completion.bins(query, ctx, fields) -&gt; entries (table), prefix (string)
&lt;a href=&quot;#completion.bins&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Return binaries/executables based on the provided parameters.
This function is meant to be used as a helper in a command completion handler. </p><p class="font-bold text-xl" id="Parameters-string-**query**">Parameters
<code>string</code> **<code>query</code>** </p><p><code>string</code> **<code>ctx</code>** </p><p><code>table</code> **<code>fields</code>** </p><p class="font-bold text-xl" id="Example-lua----an-extremely-simple-completer-for-sudo.-hilbish.complete(&#39;command.sudo&#39;-function(query-ctx-fields)- table.remove(fields-1)- if-fields[1]-then- ---return-commands-because-sudo-runs-a-command-as-root..">Example
<code>lua
-- an extremely simple completer for sudo.
hilbish.complete(&#39;command.sudo&#39;, function(query, ctx, fields)
table.remove(fields, 1)
if #fields[1] then
-- return commands because sudo runs a command as root..!</code></p><p> local entries, pfx = hilbish.completion.bins(query, ctx, fields)
return {
type = &#39;grid&#39;,
items = entries
}, pfx
end</p><p> -- ... else suggest files or anything else ..
end)
<code>
&lt;/div&gt;</code></p><p>&lt;hr&gt;
&lt;div id=&#39;completion.call&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.completion.call(name, query, ctx, fields) -&gt; completionGroups (table), prefix (string)
&lt;a href=&quot;#completion.call&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Calls a completer function. This is mainly used to call a command completer, which will have a <code>name</code>
in the form of <code>command.name</code>, example: <code>command.git</code>.
You can check the Completions doc or <code>doc completions</code> for info on the <code>completionGroups</code> return value. </p><p class="font-bold text-xl" id="Parameters-string-**name**">Parameters
<code>string</code> **<code>name</code>** </p><p><code>string</code> **<code>query</code>** </p><p><code>string</code> **<code>ctx</code>** </p><p><code>table</code> **<code>fields</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;completion.files&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.completion.files(query, ctx, fields) -&gt; entries (table), prefix (string)
&lt;a href=&quot;#completion.files&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns file matches based on the provided parameters.
This function is meant to be used as a helper in a command completion handler. </p><p class="font-bold text-xl">Parameters
<code>string</code> **<code>query</code>** </p><p><code>string</code> **<code>ctx</code>** </p><p><code>table</code> **<code>fields</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;completion.handler&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.completion.handler(line, pos)
&lt;a href=&quot;#completion.handler&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>This function contains the general completion handler for Hilbish. This function handles
completion of everything, which includes calling other command handlers, binaries, and files.
This function can be overriden to supply a custom handler. Note that alias resolution is required to be done in this function. </p><p class="font-bold text-xl" id="Parameters-string-**line**---The-current-Hilbish-command-line">Parameters
<code>string</code> **<code>line</code>**
The current Hilbish command line</p><p><code>number</code> **<code>pos</code>**
Numerical position of the cursor</p><p class="font-bold text-xl" id="Example-lua----stripped-down-version-of-the-default-implementation-function-hilbish.completion.handler(line-pos)- local-query-=-fields[fields]">Example
<code>lua
-- stripped down version of the default implementation
function hilbish.completion.handler(line, pos)
local query = fields[#fields]</code></p><p> if #fields == 1 then
-- call bins handler here
else
-- call command completer or files completer here
end
end
<code>
&lt;/div&gt;</code></p></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>

62
versions/new-website/docs/api/hilbish/hilbish.editor/index.html
View File

@ -1,62 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.editor</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.editor</h1><h2 class="font-bold text-3xl" id="Introduction-The-hilbish.editor-interface-provides-functions-to-directly-interact-with-the-line-editor-in-use.">Introduction
The hilbish.editor interface provides functions to
directly interact with the line editor in use.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;editor.deleteByAmount&quot;&gt;deleteByAmount(amount)&lt;/a&gt;|Deletes-characters-in-the-line-by-the-given-amount.|-|&lt;a-href=&quot;editor.getLine&quot;&gt;getLine()--&gt;-string&lt;/a&gt;|Returns-the-current-input-line.|-|&lt;a-href=&quot;editor.getVimRegister&quot;&gt;getVimRegister(register)--&gt;-string&lt;/a&gt;|Returns-the-text-that-is-at-the-register.|-|&lt;a-href=&quot;editor.insert&quot;&gt;insert(text)&lt;/a&gt;|Inserts-text-into-the-Hilbish-command-line.|-|&lt;a-href=&quot;editor.getChar&quot;&gt;getChar()--&gt;-string&lt;/a&gt;|Reads-a-keystroke-from-the-user.-This-is-in-a-format-of-something-like-Ctrl-L.|-|&lt;a-href=&quot;editor.setVimRegister&quot;&gt;setVimRegister(register-text)&lt;/a&gt;|Sets-the-vim-register-at-register-to-hold-the-passed-text.|">Functions
|||
|----|----|
|&lt;a href=&quot;#editor.deleteByAmount&quot;&gt;deleteByAmount(amount)&lt;/a&gt;|Deletes characters in the line by the given amount.|
|&lt;a href=&quot;#editor.getLine&quot;&gt;getLine() -&gt; string&lt;/a&gt;|Returns the current input line.|
|&lt;a href=&quot;#editor.getVimRegister&quot;&gt;getVimRegister(register) -&gt; string&lt;/a&gt;|Returns the text that is at the register.|
|&lt;a href=&quot;#editor.insert&quot;&gt;insert(text)&lt;/a&gt;|Inserts text into the Hilbish command line.|
|&lt;a href=&quot;#editor.getChar&quot;&gt;getChar() -&gt; string&lt;/a&gt;|Reads a keystroke from the user. This is in a format of something like Ctrl-L.|
|&lt;a href=&quot;#editor.setVimRegister&quot;&gt;setVimRegister(register, text)&lt;/a&gt;|Sets the vim register at <code>register</code> to hold the passed text.|</h2><p>&lt;hr&gt;
&lt;div id=&#39;editor.deleteByAmount&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.editor.deleteByAmount(amount)
&lt;a href=&quot;#editor.deleteByAmount&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Deletes characters in the line by the given amount. </p><p class="font-bold text-xl" id="Parameters-number-**amount**">Parameters
<code>number</code> **<code>amount</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;editor.getLine&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.editor.getLine() -&gt; string
&lt;a href=&quot;#editor.getLine&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the current input line. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;editor.getVimRegister&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.editor.getVimRegister(register) -&gt; string
&lt;a href=&quot;#editor.getVimRegister&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the text that is at the register. </p><p class="font-bold text-xl" id="Parameters-string-**register**">Parameters
<code>string</code> **<code>register</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;editor.insert&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.editor.insert(text)
&lt;a href=&quot;#editor.insert&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Inserts text into the Hilbish command line. </p><p class="font-bold text-xl" id="Parameters-string-**text**">Parameters
<code>string</code> **<code>text</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;editor.getChar&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.editor.getChar() -&gt; string
&lt;a href=&quot;#editor.getChar&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Reads a keystroke from the user. This is in a format of something like Ctrl-L. </p><p class="font-bold text-xl">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;editor.setVimRegister&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.editor.setVimRegister(register, text)
&lt;a href=&quot;#editor.setVimRegister&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Sets the vim register at <code>register</code> to hold the passed text. </p><p class="font-bold text-xl">Parameters
<code>string</code> **<code>register</code>** </p><p><code>string</code> **<code>text</code>** </p><p>&lt;/div&gt;</p></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>

55
versions/new-website/docs/api/hilbish/hilbish.history/index.html
View File

@ -1,55 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.history</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.history</h1><h2 class="font-bold text-3xl" id="Introduction-The-history-interface-deals-with-command-history.-This-includes-the-ability-to-override-functions-to-change-the-main-method-of-saving-history.">Introduction
The history interface deals with command history.
This includes the ability to override functions to change the main
method of saving history.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;history.add&quot;&gt;add(cmd)&lt;/a&gt;|Adds-a-command-to-the-history.|-|&lt;a-href=&quot;history.all&quot;&gt;all()--&gt;-table&lt;/a&gt;|Retrieves-all-history-as-a-table.|-|&lt;a-href=&quot;history.clear&quot;&gt;clear()&lt;/a&gt;|Deletes-all-commands-from-the-history.|-|&lt;a-href=&quot;history.get&quot;&gt;get(index)&lt;/a&gt;|Retrieves-a-command-from-the-history-based-on-the-index.|-|&lt;a-href=&quot;history.size&quot;&gt;size()--&gt;-number&lt;/a&gt;|Returns-the-amount-of-commands-in-the-history.|">Functions
|||
|----|----|
|&lt;a href=&quot;#history.add&quot;&gt;add(cmd)&lt;/a&gt;|Adds a command to the history.|
|&lt;a href=&quot;#history.all&quot;&gt;all() -&gt; table&lt;/a&gt;|Retrieves all history as a table.|
|&lt;a href=&quot;#history.clear&quot;&gt;clear()&lt;/a&gt;|Deletes all commands from the history.|
|&lt;a href=&quot;#history.get&quot;&gt;get(index)&lt;/a&gt;|Retrieves a command from the history based on the <code>index</code>.|
|&lt;a href=&quot;#history.size&quot;&gt;size() -&gt; number&lt;/a&gt;|Returns the amount of commands in the history.|</h2><p>&lt;hr&gt;
&lt;div id=&#39;history.add&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.history.add(cmd)
&lt;a href=&quot;#history.add&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Adds a command to the history. </p><p class="font-bold text-xl" id="Parameters-string-**cmd**">Parameters
<code>string</code> **<code>cmd</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;history.all&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.history.all() -&gt; table
&lt;a href=&quot;#history.all&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Retrieves all history as a table. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;history.clear&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.history.clear()
&lt;a href=&quot;#history.clear&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Deletes all commands from the history. </p><p class="font-bold text-xl">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;history.get&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.history.get(index)
&lt;a href=&quot;#history.get&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Retrieves a command from the history based on the <code>index</code>. </p><p class="font-bold text-xl" id="Parameters-number-**index**">Parameters
<code>number</code> **<code>index</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;history.size&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.history.size() -&gt; number
&lt;a href=&quot;#history.size&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the amount of commands in the history. </p><p class="font-bold text-xl">Parameters
This function has no parameters.
&lt;/div&gt;</p></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>

78
versions/new-website/docs/api/hilbish/hilbish.jobs/index.html
View File

@ -1,78 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.jobs</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.jobs</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>Manage interactive jobs in Hilbish via Lua.</p><p>Jobs are the name of background tasks/commands. A job can be started via
interactive usage or with the functions defined below for use in external runners.</p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;jobs.add&quot;&gt;add(cmdstr-args-execPath)&lt;/a&gt;|Creates-a-new-job.-This-function-does-not-run-the-job.-This-function-is-intended-to-be|-|&lt;a-href=&quot;jobs.all&quot;&gt;all()--&gt;-table[@Job]&lt;/a&gt;|Returns-a-table-of-all-job-objects.|-|&lt;a-href=&quot;jobs.disown&quot;&gt;disown(id)&lt;/a&gt;|Disowns-a-job.-This-simply-deletes-it-from-the-list-of-jobs-without-stopping-it.|-|&lt;a-href=&quot;jobs.get&quot;&gt;get(id)--&gt;-@Job&lt;/a&gt;|Get-a-job-object-via-its-ID.|-|&lt;a-href=&quot;jobs.last&quot;&gt;last()--&gt;-@Job&lt;/a&gt;|Returns-the-last-added-job-to-the-table.|">Functions
|||
|----|----|
|&lt;a href=&quot;#jobs.add&quot;&gt;add(cmdstr, args, execPath)&lt;/a&gt;|Creates a new job. This function does not run the job. This function is intended to be|
|&lt;a href=&quot;#jobs.all&quot;&gt;all() -&gt; table[@Job]&lt;/a&gt;|Returns a table of all job objects.|
|&lt;a href=&quot;#jobs.disown&quot;&gt;disown(id)&lt;/a&gt;|Disowns a job. This simply deletes it from the list of jobs without stopping it.|
|&lt;a href=&quot;#jobs.get&quot;&gt;get(id) -&gt; @Job&lt;/a&gt;|Get a job object via its ID.|
|&lt;a href=&quot;#jobs.last&quot;&gt;last() -&gt; @Job&lt;/a&gt;|Returns the last added job to the table.|</h2><p>&lt;hr&gt;
&lt;div id=&#39;jobs.add&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.jobs.add(cmdstr, args, execPath)
&lt;a href=&quot;#jobs.add&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Creates a new job. This function does not run the job. This function is intended to be
used by runners, but can also be used to create jobs via Lua. Commanders cannot be ran as jobs. </p><p class="font-bold text-xl" id="Parameters-string-**cmdstr**---String-that-a-user-would-write-for-the-job">Parameters
<code>string</code> **<code>cmdstr</code>**
String that a user would write for the job</p><p><code>table</code> **<code>args</code>**
Arguments for the commands. Has to include the name of the command.</p><p><code>string</code> **<code>execPath</code>**
Binary to use to run the command. Needs to be an absolute path.</p><p class="font-bold text-xl" id="Example-lua-hilbish.jobs.add(&#39;go-build&#39;-{&#39;go&#39;-&#39;build&#39;}-&#39;/usr/bin/go&#39;)--&lt;/div&gt;">Example
<code>lua
hilbish.jobs.add(&#39;go build&#39;, {&#39;go&#39;, &#39;build&#39;}, &#39;/usr/bin/go&#39;)
</code>
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;jobs.all&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.jobs.all() -&gt; table[&lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.jobs/#job&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Job&lt;/a&gt;]
&lt;a href=&quot;#jobs.all&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns a table of all job objects. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;jobs.disown&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.jobs.disown(id)
&lt;a href=&quot;#jobs.disown&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Disowns a job. This simply deletes it from the list of jobs without stopping it. </p><p class="font-bold text-xl" id="Parameters-number-**id**">Parameters
<code>number</code> **<code>id</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;jobs.get&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.jobs.get(id) -&gt; &lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.jobs/#job&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Job&lt;/a&gt;
&lt;a href=&quot;#jobs.get&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Get a job object via its ID. </p><p class="font-bold text-xl">Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;jobs.last&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.jobs.last() -&gt; &lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.jobs/#job&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Job&lt;/a&gt;
&lt;a href=&quot;#jobs.last&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the last added job to the table. </p><p class="font-bold text-xl">Parameters
This function has no parameters.
&lt;/div&gt;</p><h2 class="font-bold text-3xl" id="Types-&lt;hr&gt;">Types
&lt;hr&gt;</h2><h2 class="font-bold text-3xl" id="Job-The-Job-type-describes-a-Hilbish-job.-Object-properties-|||-|----|----|-|cmd|The-user-entered-command-string-for-the-job.|-|running|Whether-the-job-is-running-or-not.|-|id|The-ID-of-the-job-in-the-job-table|-|pid|The-Process-ID|-|exitCode|The-last-exit-code-of-the-job.|-|stdout|The-standard-output-of-the-job.-This-just-means-the-normal-logs-of-the-process.|-|stderr|The-standard-error-stream-of-the-process.-This-(usually)-includes-error-messages-of-the-job.|">Job
The Job type describes a Hilbish job.
Object properties
|||
|----|----|
|cmd|The user entered command string for the job.|
|running|Whether the job is running or not.|
|id|The ID of the job in the job table|
|pid|The Process ID|
|exitCode|The last exit code of the job.|
|stdout|The standard output of the job. This just means the normal logs of the process.|
|stderr|The standard error stream of the process. This (usually) includes error messages of the job.|</h2><h3 class="font-bold text-2xl" id="Methods">Methods</h3><p class="font-bold text-xl" id="background()-Puts-a-job-in-the-background.-This-acts-the-same-as-initially-running-a-job.">background()
Puts a job in the background. This acts the same as initially running a job.</p><p class="font-bold text-xl" id="foreground()-Puts-a-job-in-the-foreground.-This-will-cause-it-to-run-like-it-was-executed-normally-and-wait-for-it-to-complete.">foreground()
Puts a job in the foreground. This will cause it to run like it was
executed normally and wait for it to complete.</p><p class="font-bold text-xl" id="start()-Starts-running-the-job.">start()
Starts running the job.</p><p class="font-bold text-xl" id="stop()-Stops-the-job-from-running.">stop()
Stops the job from running.</p></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>

88
versions/new-website/docs/api/hilbish/hilbish.messages/index.html
View File

@ -1,88 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.messages</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.messages</h1><h2 class="font-bold text-3xl" id="Introduction-The-messages-interface-defines-a-way-for-Hilbish-integrated-commands-user-config-and-other-tasks-to-send-notifications-to-alert-the-user.z-The-hilbish.message-type-is-a-table-with-the-following-keys:-title-(string):-A-title-for-the-message-notification.-text-(string):-The-contents-of-the-message.-channel-(string):-States-the-origin-of-the-message-hilbish.*-is-reserved-for-Hilbish-tasks.-summary-(string):-A-short-summary-of-the-text.-icon-(string):-Unicode-(preferably-standard-emoji)-icon-for-the-message-notification-read-(boolean):-Whether-the-full-message-has-been-read-or-not.">Introduction
The messages interface defines a way for Hilbish-integrated commands,
user config and other tasks to send notifications to alert the user.z
The <code>hilbish.message</code> type is a table with the following keys:
<code>title</code> (string): A title for the message notification.
<code>text</code> (string): The contents of the message.
<code>channel</code> (string): States the origin of the message, <code>hilbish.*</code> is reserved for Hilbish tasks.
<code>summary</code> (string): A short summary of the <code>text</code>.
<code>icon</code> (string): Unicode (preferably standard emoji) icon for the message notification
<code>read</code> (boolean): Whether the full message has been read or not.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;unreadCount&quot;&gt;unreadCount()&lt;/a&gt;|Returns-the-amount-of-unread-messages.|-|&lt;a-href=&quot;send&quot;&gt;send(message)&lt;/a&gt;|Sends-a-message.|-|&lt;a-href=&quot;readAll&quot;&gt;readAll()&lt;/a&gt;|Marks-all-messages-as-read.|-|&lt;a-href=&quot;read&quot;&gt;read(idx)&lt;/a&gt;|Marks-a-message-at-idx-as-read.|-|&lt;a-href=&quot;delete&quot;&gt;delete(idx)&lt;/a&gt;|Deletes-the-message-at-idx.|-|&lt;a-href=&quot;clear&quot;&gt;clear()&lt;/a&gt;|Deletes-all-messages.|-|&lt;a-href=&quot;all&quot;&gt;all()&lt;/a&gt;|Returns-all-messages.|-&lt;hr&gt;-&lt;div-id=&#39;all&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-hilbish.messages.all()-&lt;a-href=&quot;all&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions
|||
|----|----|
|&lt;a href=&quot;#unreadCount&quot;&gt;unreadCount()&lt;/a&gt;|Returns the amount of unread messages.|
|&lt;a href=&quot;#send&quot;&gt;send(message)&lt;/a&gt;|Sends a message.|
|&lt;a href=&quot;#readAll&quot;&gt;readAll()&lt;/a&gt;|Marks all messages as read.|
|&lt;a href=&quot;#read&quot;&gt;read(idx)&lt;/a&gt;|Marks a message at <code>idx</code> as read.|
|&lt;a href=&quot;#delete&quot;&gt;delete(idx)&lt;/a&gt;|Deletes the message at <code>idx</code>.|
|&lt;a href=&quot;#clear&quot;&gt;clear()&lt;/a&gt;|Deletes all messages.|
|&lt;a href=&quot;#all&quot;&gt;all()&lt;/a&gt;|Returns all messages.|
&lt;hr&gt;
&lt;div id=&#39;all&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.all()
&lt;a href=&quot;#all&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</h2><p>Returns all messages.
#### Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;clear&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.clear()
&lt;a href=&quot;#clear&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Deletes all messages.
#### Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;delete&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.delete(idx)
&lt;a href=&quot;#delete&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Deletes the message at <code>idx</code>.
#### Parameters
<code>idx</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;read&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.read(idx)
&lt;a href=&quot;#read&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Marks a message at <code>idx</code> as read.
#### Parameters
<code>idx</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;readAll&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.readAll()
&lt;a href=&quot;#readAll&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Marks all messages as read.
#### Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;send&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.send(message)
&lt;a href=&quot;#send&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Sends a message.
#### Parameters
<code>message</code> **<code>hilbish.message</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;unreadCount&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.messages.unreadCount()
&lt;a href=&quot;#unreadCount&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the amount of unread messages.
#### Parameters
This function has no parameters.
&lt;/div&gt;</p></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>

33
versions/new-website/docs/api/hilbish/hilbish.module/index.html
View File

@ -1,33 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.module</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.module</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>The hilbish.module interface provides a function to load
Hilbish plugins/modules. Hilbish modules are Go-written
plugins (see https://pkg.go.dev/plugin) that are used to add functionality
to Hilbish that cannot be written in Lua for any reason.</p><p>Note that you don&#39;t ever need to use the load function that is here as
modules can be loaded with a <code>require</code> call like Lua C modules, and the
search paths can be changed with the <code>paths</code> property here.</p><p>To make a valid native module, the Go plugin has to export a Loader function
with a signature like so: <code>func(*rt.Runtime) rt.Value</code>.</p><p><code>rt</code> in this case refers to the Runtime type at
https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime</p><p>Hilbish uses this package as its Lua runtime. You will need to read
it to use it for a native plugin.</p><p>Here is some code for an example plugin:
<code>go
package main</code></p><p>import (
rt &quot;github.com/arnodel/golua/runtime&quot;
)</p><p>func Loader(rtm *rt.Runtime) rt.Value {
return rt.StringValue(&quot;hello world!&quot;)
}
<code></code></p><p>This can be compiled with <code>go build -buildmode=plugin plugin.go</code>.
If you attempt to require and print the result (<code>print(require &#39;plugin&#39;)</code>), it will show &quot;hello world!&quot;</p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;module.load&quot;&gt;load(path)&lt;/a&gt;|Loads-a-module-at-the-designated-path.|">Functions
|||
|----|----|
|&lt;a href=&quot;#module.load&quot;&gt;load(path)&lt;/a&gt;|Loads a module at the designated <code>path</code>.|</h2><h2 class="font-bold text-3xl" id="Static-module-fields-|||-|----|----|-|paths|A-list-of-paths-to-search-when-loading-native-modules.-This-is-in-the-style-of-Lua-search-paths-and-will-be-used-when-requiring-native-modules.-Example:-.so;/.so|">Static module fields
|||
|----|----|
|paths|A list of paths to search when loading native modules. This is in the style of Lua search paths and will be used when requiring native modules. Example: <code>?.so;?/?.so</code>|</h2><p>&lt;hr&gt;
&lt;div id=&#39;module.load&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.module.load(path)
&lt;a href=&quot;#module.load&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Loads a module at the designated <code>path</code>.
It will throw if any error occurs. </p><p class="font-bold text-xl" id="Parameters-string-**path**">Parameters
<code>string</code> **<code>path</code>** </p><p>&lt;/div&gt;</p></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>

9
versions/new-website/docs/api/hilbish/hilbish.os/index.html
View File

@ -1,9 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.os</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.os</h1><h2 class="font-bold text-3xl" id="Introduction-Provides-simple-text-information-properties-about-the-current-operating-system.-This-mainly-includes-the-name-and-version.">Introduction
Provides simple text information properties about the current operating system.
This mainly includes the name and version.</h2><h2 class="font-bold text-3xl" id="Static-module-fields-|||-|----|----|-|family|Family-name-of-the-current-OS|-|name|Pretty-name-of-the-current-OS|-|version|Version-of-the-current-OS|">Static module fields
|||
|----|----|
|family|Family name of the current OS|
|name|Pretty name of the current OS|
|version|Version of the current OS|</h2></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>

146
versions/new-website/docs/api/hilbish/hilbish.runner/index.html
View File

@ -1,146 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.runner</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.runner</h1><h2 class="font-bold text-3xl" id="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.">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.</h2><p>Runners are functions that evaluate user input. The default runners in
Hilbish can run shell script and Lua code.</p><p>A runner is passed the input and has to return a table with these values.
All are not required, only the useful ones the runner needs to return.
(So if there isn&#39;t an error, just omit <code>err</code>.)</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code>exitCode</code> (number): Exit code of the command</p></li><li><p><code>input</code> (string): The text input of the user. This is used by Hilbish to append extra input, in case</p></li></ul><p>more is requested.
- <code>err</code> (string): A string that represents an error from the runner.
This should only be set when, for example, there is a syntax error.
It can be set to a few special values for Hilbish to throw the right
hooks and have a better looking message.
- <code>\&lt;command&gt;: not-found</code> will throw a <code>command.not-found</code> hook
based on what <code>\&lt;command&gt;</code> is.
- <code>\&lt;command&gt;: not-executable</code> will throw a <code>command.not-executable</code> hook.
- <code>continue</code> (boolean): Whether Hilbish should prompt the user for no input
- <code>newline</code> (boolean): Whether a newline should be added at the end of <code>input</code>.</p><p>Here is a simple example of a fennel runner. It falls back to
shell script if fennel eval has an error.
<code>lua
local fennel = require &#39;fennel&#39;</code></p><p>hilbish.runnerMode(function(input)
local ok = pcall(fennel.eval, input)
if ok then
return {
input = input
}
end</p><p> return hilbish.runner.sh(input)
end)
<code></code></p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;runner.lua&quot;&gt;lua(cmd)&lt;/a&gt;|Evaluates-cmd-as-Lua-input.-This-is-the-same-as-using-dofile|-|&lt;a-href=&quot;sh&quot;&gt;sh()&lt;/a&gt;|nil|-|&lt;a-href=&quot;setMode&quot;&gt;setMode(mode)&lt;/a&gt;|*NOTE:-This-function-is-deprecated-and-will-be-removed-in-3.0|-|&lt;a-href=&quot;setCurrent&quot;&gt;setCurrent(name)&lt;/a&gt;|Sets-Hilbish&#39;s-runner-mode-by-name.|-|&lt;a-href=&quot;set&quot;&gt;set(name-runner)&lt;/a&gt;|Sets*-a-runner-by-name.-The-difference-between-this-function-and|-|&lt;a-href=&quot;run&quot;&gt;run(input-priv)&lt;/a&gt;|Runs-input-with-the-currently-set-Hilbish-runner.|-|&lt;a-href=&quot;getCurrent&quot;&gt;getCurrent()&lt;/a&gt;|Returns-the-current-runner-by-name.|-|&lt;a-href=&quot;get&quot;&gt;get(name)&lt;/a&gt;|Get-a-runner-by-name.|-|&lt;a-href=&quot;exec&quot;&gt;exec(cmd-runnerName)&lt;/a&gt;|Executes-cmd-with-a-runner.|-|&lt;a-href=&quot;add&quot;&gt;add(name-runner)&lt;/a&gt;|Adds-a-runner-to-the-table-of-available-runners.|">Functions
|||
|----|----|
|&lt;a href=&quot;#runner.lua&quot;&gt;lua(cmd)&lt;/a&gt;|Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code>|
|&lt;a href=&quot;#sh&quot;&gt;sh()&lt;/a&gt;|nil|
|&lt;a href=&quot;#setMode&quot;&gt;setMode(mode)&lt;/a&gt;|*<strong>NOTE: This function is deprecated and will be removed in 3.0</strong><strong>|
|&lt;a href=&quot;#setCurrent&quot;&gt;setCurrent(name)&lt;/a&gt;|Sets Hilbish&#39;s runner mode by name.|
|&lt;a href=&quot;#set&quot;&gt;set(name, runner)&lt;/a&gt;|</strong>Sets* a runner by name. The difference between this function and|
|&lt;a href=&quot;#run&quot;&gt;run(input, priv)&lt;/a&gt;|Runs <code>input</code> with the currently set Hilbish runner.|
|&lt;a href=&quot;#getCurrent&quot;&gt;getCurrent()&lt;/a&gt;|Returns the current runner by name.|
|&lt;a href=&quot;#get&quot;&gt;get(name)&lt;/a&gt;|Get a runner by name.|
|&lt;a href=&quot;#exec&quot;&gt;exec(cmd, runnerName)&lt;/a&gt;|Executes <code>cmd</code> with a runner.|
|&lt;a href=&quot;#add&quot;&gt;add(name, runner)&lt;/a&gt;|Adds a runner to the table of available runners.|</h2><p>&lt;hr&gt;
&lt;div id=&#39;runner.lua&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.lua(cmd)
&lt;a href=&quot;#runner.lua&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code>
or <code>load</code>, but is appropriated for the runner interface. </p><p class="font-bold text-xl" id="Parameters-string-**cmd**">Parameters
<code>string</code> **<code>cmd</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;add&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.add(name, runner)
&lt;a href=&quot;#add&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Adds a runner to the table of available runners.
If runner is a table, it must have the run function in it.
#### Parameters
<code>name</code> **<code>string</code>**
Name of the runner</p><p><code>runner</code> **<code>function|table</code>**
</p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;exec&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.exec(cmd, runnerName)
&lt;a href=&quot;#exec&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Executes <code>cmd</code> with a runner.
If <code>runnerName</code> is not specified, it uses the default Hilbish runner.
#### Parameters
<code>cmd</code> **<code>string</code>** </p><p><code>runnerName</code> **<code>string?</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;get&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.get(name)
&lt;a href=&quot;#get&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Get a runner by name.
#### Parameters
<code>name</code> **<code>string</code>**
Name of the runner to retrieve.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;getCurrent&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.getCurrent()
&lt;a href=&quot;#getCurrent&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Returns the current runner by name.
#### Parameters
This function has no parameters.
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;run&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.run(input, priv)
&lt;a href=&quot;#run&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Runs <code>input</code> with the currently set Hilbish runner.
This method is how Hilbish executes commands.
<code>priv</code> is an optional boolean used to state if the input should be saved to history.
#### Parameters
<code>input</code> **<code>string</code>** </p><p><code>priv</code> **<code>bool</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;set&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.set(name, runner)
&lt;a href=&quot;#set&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p><strong>Sets</strong> a runner by name. The difference between this function and
add, is set will <strong>not</strong> check if the named runner exists.
The runner table must have the run function in it.
#### Parameters
<code>name</code> **<code>string</code>** </p><p><code>runner</code> **<code>table</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;setCurrent&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.setCurrent(name)
&lt;a href=&quot;#setCurrent&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Sets Hilbish&#39;s runner mode by name.
#### Parameters
<code>name</code> **<code>string</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;setMode&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.setMode(mode)
&lt;a href=&quot;#setMode&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>*<strong>NOTE: This function is deprecated and will be removed in 3.0</strong>*
Use <code>hilbish.runner.setCurrent</code> instead.
This is the same as the <code>hilbish.runnerMode</code> function.
It takes a callback, which will be used to execute all interactive input.
Or a string which names the runner mode to use.
#### Parameters
<code>mode</code> **<code>string|function</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;sh&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runner.sh()
&lt;a href=&quot;#sh&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters
This function has no parameters.
&lt;/div&gt;</p></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>

48
versions/new-website/docs/api/hilbish/hilbish.timers/index.html
View File

@ -1,48 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.timers</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.timers</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>If you ever want to run a piece of code on a timed interval, or want to wait
a few seconds, you don&#39;t have to rely on timing tricks, as Hilbish has a
timer API to set intervals and timeouts.</p><p>These are the simple functions <code>hilbish.interval</code> and <code>hilbish.timeout</code> (doc
accessible with <code>doc hilbish</code>, or <code>Module hilbish</code> on the Website).</p><p>An example of usage:
<code>lua
local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function()
print &#39;hello!&#39;
end)</code></p><p>t:start()
print(t.running) // true
<code></code></p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;timers.create&quot;&gt;create(type-time-callback)--&gt;-@Timer&lt;/a&gt;|Creates-a-timer-that-runs-based-on-the-specified-time.|-|&lt;a-href=&quot;timers.get&quot;&gt;get(id)--&gt;-@Timer&lt;/a&gt;|Retrieves-a-timer-via-its-ID.|">Functions
|||
|----|----|
|&lt;a href=&quot;#timers.create&quot;&gt;create(type, time, callback) -&gt; @Timer&lt;/a&gt;|Creates a timer that runs based on the specified <code>time</code>.|
|&lt;a href=&quot;#timers.get&quot;&gt;get(id) -&gt; @Timer&lt;/a&gt;|Retrieves a timer via its ID.|</h2><h2 class="font-bold text-3xl" id="Static-module-fields-|||-|----|----|-|INTERVAL|Constant-for-an-interval-timer-type|-|TIMEOUT|Constant-for-a-timeout-timer-type|">Static module fields
|||
|----|----|
|INTERVAL|Constant for an interval timer type|
|TIMEOUT|Constant for a timeout timer type|</h2><p>&lt;hr&gt;
&lt;div id=&#39;timers.create&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.timers.create(type, time, callback) -&gt; &lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.timers/#timer&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Timer&lt;/a&gt;
&lt;a href=&quot;#timers.create&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Creates a timer that runs based on the specified <code>time</code>. </p><p class="font-bold text-xl" id="Parameters-number-**type**---What-kind-of-timer-to-create-can-either-be-hilbish.timers.INTERVAL-or-hilbish.timers.TIMEOUT">Parameters
<code>number</code> **<code>type</code>**
What kind of timer to create, can either be <code>hilbish.timers.INTERVAL</code> or <code>hilbish.timers.TIMEOUT</code></p><p><code>number</code> **<code>time</code>**
The amount of time the function should run in milliseconds.</p><p><code>function</code> **<code>callback</code>**
The function to run for the timer.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;timers.get&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.timers.get(id) -&gt; &lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.timers/#timer&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Timer&lt;/a&gt;
&lt;a href=&quot;#timers.get&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Retrieves a timer via its ID. </p><p class="font-bold text-xl" id="Parameters-number-**id**">Parameters
<code>number</code> **<code>id</code>** </p><p>&lt;/div&gt;</p><h2 class="font-bold text-3xl" id="Types-&lt;hr&gt;">Types
&lt;hr&gt;</h2><h2 class="font-bold text-3xl" id="Timer-The-Job-type-describes-a-Hilbish-timer.-Object-properties-|||-|----|----|-|type|What-type-of-timer-it-is|-|running|If-the-timer-is-running|-|duration|The-duration-in-milliseconds-that-the-timer-will-run|">Timer
The Job type describes a Hilbish timer.
Object properties
|||
|----|----|
|type|What type of timer it is|
|running|If the timer is running|
|duration|The duration in milliseconds that the timer will run|</h2><h3 class="font-bold text-2xl" id="Methods">Methods</h3><p class="font-bold text-xl" id="start()-Starts-a-timer.">start()
Starts a timer.</p><p class="font-bold text-xl" id="stop()-Stops-a-timer.">stop()
Stops a timer.</p></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>

9
versions/new-website/docs/api/hilbish/hilbish.userdir/index.html
View File

@ -1,9 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish.userDir</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish.userDir</h1><h2 class="font-bold text-3xl" id="Introduction-This-interface-just-contains-properties-to-know-about-certain-user-directories.-It-is-equivalent-to-XDG-on-Linux-and-gets-the-user&#39;s-preferred-directories-for-configs-and-data.">Introduction
This interface just contains properties to know about certain user directories.
It is equivalent to XDG on Linux and gets the user&#39;s preferred directories
for configs and data.</h2><h2 class="font-bold text-3xl" id="Static-module-fields-|||-|----|----|-|config|The-user&#39;s-config-directory|-|data|The-user&#39;s-directory-for-program-data|">Static module fields
|||
|----|----|
|config|The user&#39;s config directory|
|data|The user&#39;s directory for program data|</h2></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>

539
versions/new-website/docs/api/hilbish/index.html
View File

@ -1,87 +1,158 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module hilbish</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module hilbish</h1><h2 class="font-bold text-3xl" id="Introduction-The-Hilbish-module-includes-the-core-API-containing-interfaces-and-functions-which-directly-relate-to-shell-functionality.">Introduction <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module hilbish</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module hilbish</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>The Hilbish module includes the core API, containing
The Hilbish module includes the core API, containing interfaces and functions which directly relate to shell functionality.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
interfaces and functions which directly relate to shell functionality.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;alias&quot;&gt;alias(cmd-orig)&lt;/a&gt;|Sets-an-alias-with-a-name-of-cmd-to-another-command.|-|&lt;a-href=&quot;appendPath&quot;&gt;appendPath(dir)&lt;/a&gt;|Appends-the-provided-dir-to-the-command-path-($PATH)|-|&lt;a-href=&quot;complete&quot;&gt;complete(scope-cb)&lt;/a&gt;|Registers-a-completion-handler-for-the-specified-scope.|-|&lt;a-href=&quot;cwd&quot;&gt;cwd()--&gt;-string&lt;/a&gt;|Returns-the-current-directory-of-the-shell.|-|&lt;a-href=&quot;exec&quot;&gt;exec(cmd)&lt;/a&gt;|Replaces-the-currently-running-Hilbish-instance-with-the-supplied-command.|-|&lt;a-href=&quot;goro&quot;&gt;goro(fn)&lt;/a&gt;|Puts-fn-in-a-Goroutine.|-|&lt;a-href=&quot;highlighter&quot;&gt;highlighter(line)&lt;/a&gt;|Line-highlighter-handler.|-|&lt;a-href=&quot;hinter&quot;&gt;hinter(line-pos)&lt;/a&gt;|The-command-line-hint-handler.-It-gets-called-on-every-key-insert-to|-|&lt;a-href=&quot;inputMode&quot;&gt;inputMode(mode)&lt;/a&gt;|Sets-the-input-mode-for-Hilbish&#39;s-line-reader.|-|&lt;a-href=&quot;interval&quot;&gt;interval(cb-time)--&gt;-@Timer&lt;/a&gt;|Runs-the-cb-function-every-specified-amount-of-time.|-|&lt;a-href=&quot;multiprompt&quot;&gt;multiprompt(str)&lt;/a&gt;|Changes-the-text-prompt-when-Hilbish-asks-for-more-input.|-|&lt;a-href=&quot;prependPath&quot;&gt;prependPath(dir)&lt;/a&gt;|Prepends-dir-to-$PATH.|-|&lt;a-href=&quot;prompt&quot;&gt;prompt(str-typ)&lt;/a&gt;|Changes-the-shell-prompt-to-the-provided-string.|-|&lt;a-href=&quot;read&quot;&gt;read(prompt)--&gt;-input-(string)&lt;/a&gt;|Read-input-from-the-user-using-Hilbish&#39;s-line-editor/input-reader.|-|&lt;a-href=&quot;timeout&quot;&gt;timeout(cb-time)--&gt;-@Timer&lt;/a&gt;|Executed-the-cb-function-after-a-period-of-time.|-|&lt;a-href=&quot;which&quot;&gt;which(name)--&gt;-string&lt;/a&gt;|Checks-if-name-is-a-valid-command.|-|&lt;a-href=&quot;runnerMode&quot;&gt;runnerMode(mode)&lt;/a&gt;|Sets-the-execution/runner-mode-for-interactive-Hilbish.|-|&lt;a-href=&quot;run&quot;&gt;run(cmd-streams)&lt;/a&gt;|Runs-cmd-in-Hilbish&#39;s-shell-script-interpreter.|">Functions <table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
||| <tbody>
|----|----| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#alias&quot;&gt;alias(cmd, orig)&lt;/a&gt;|Sets an alias, with a name of <code>cmd</code> to another command.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#alias">alias(cmd, orig)</a></td>
|&lt;a href=&quot;#appendPath&quot;&gt;appendPath(dir)&lt;/a&gt;|Appends the provided dir to the command path (<code>$PATH</code>)| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Sets an alias, with a name of `cmd` to another command.</td>
|&lt;a href=&quot;#complete&quot;&gt;complete(scope, cb)&lt;/a&gt;|Registers a completion handler for the specified scope.| </tr>
|&lt;a href=&quot;#cwd&quot;&gt;cwd() -&gt; string&lt;/a&gt;|Returns the current directory of the shell.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#exec&quot;&gt;exec(cmd)&lt;/a&gt;|Replaces the currently running Hilbish instance with the supplied command.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#appendPath">appendPath(dir)</a></td>
|&lt;a href=&quot;#goro&quot;&gt;goro(fn)&lt;/a&gt;|Puts <code>fn</code> in a Goroutine.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Appends the provided dir to the command path (`$PATH`)</td>
|&lt;a href=&quot;#highlighter&quot;&gt;highlighter(line)&lt;/a&gt;|Line highlighter handler.| </tr>
|&lt;a href=&quot;#hinter&quot;&gt;hinter(line, pos)&lt;/a&gt;|The command line hint handler. It gets called on every key insert to| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#inputMode&quot;&gt;inputMode(mode)&lt;/a&gt;|Sets the input mode for Hilbish&#39;s line reader.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#complete">complete(scope, cb)</a></td>
|&lt;a href=&quot;#interval&quot;&gt;interval(cb, time) -&gt; @Timer&lt;/a&gt;|Runs the <code>cb</code> function every specified amount of <code>time</code>.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Registers a completion handler for the specified scope.</td>
|&lt;a href=&quot;#multiprompt&quot;&gt;multiprompt(str)&lt;/a&gt;|Changes the text prompt when Hilbish asks for more input.| </tr>
|&lt;a href=&quot;#prependPath&quot;&gt;prependPath(dir)&lt;/a&gt;|Prepends <code>dir</code> to $PATH.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#prompt&quot;&gt;prompt(str, typ)&lt;/a&gt;|Changes the shell prompt to the provided string.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#cwd">cwd() -> string</a></td>
|&lt;a href=&quot;#read&quot;&gt;read(prompt) -&gt; input (string)&lt;/a&gt;|Read input from the user, using Hilbish&#39;s line editor/input reader.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns the current directory of the shell.</td>
|&lt;a href=&quot;#timeout&quot;&gt;timeout(cb, time) -&gt; @Timer&lt;/a&gt;|Executed the <code>cb</code> function after a period of <code>time</code>.| </tr>
|&lt;a href=&quot;#which&quot;&gt;which(name) -&gt; string&lt;/a&gt;|Checks if <code>name</code> is a valid command.| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#runnerMode&quot;&gt;runnerMode(mode)&lt;/a&gt;|Sets the execution/runner mode for interactive Hilbish.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#exec">exec(cmd)</a></td>
|&lt;a href=&quot;#run&quot;&gt;run(cmd, streams)&lt;/a&gt;|Runs <code>cmd</code> in Hilbish&#39;s shell script interpreter.|</h2><h2 class="font-bold text-3xl" id="Static-module-fields-|||-|----|----|-|ver|The-version-of-Hilbish|-|goVersion|The-version-of-Go-that-Hilbish-was-compiled-with|-|user|Username-of-the-user|-|host|Hostname-of-the-machine|-|dataDir|Directory-for-Hilbish-data-files-including-the-docs-and-default-modules|-|interactive|Is-Hilbish-in-an-interactive-shell|-|login|Is-Hilbish-the-login-shell|-|vimMode|Current-Vim-input-mode-of-Hilbish-(will-be-nil-if-not-in-Vim-input-mode)|-|exitCode|Exit-code-of-the-last-executed-command|">Static module fields <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Replaces the currently running Hilbish instance with the supplied command.</td>
||| </tr>
|----|----| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|ver|The version of Hilbish| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#goro">goro(fn)</a></td>
|goVersion|The version of Go that Hilbish was compiled with| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Puts `fn` in a Goroutine.</td>
|user|Username of the user| </tr>
|host|Hostname of the machine| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|dataDir|Directory for Hilbish data files, including the docs and default modules| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#highlighter">highlighter(line)</a></td>
|interactive|Is Hilbish in an interactive shell?| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Line highlighter handler.</td>
|login|Is Hilbish the login shell?| </tr>
|vimMode|Current Vim input mode of Hilbish (will be nil if not in Vim input mode)| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|exitCode|Exit code of the last executed command|</h2><p>&lt;hr&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#hinter">hinter(line, pos)</a></td>
&lt;div id=&#39;alias&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>The command line hint handler. It gets called on every key insert to</td>
&lt;h4 class=&#39;heading&#39;&gt; </tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#inputMode">inputMode(mode)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Sets the input mode for Hilbish's line reader.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#interval">interval(cb, time) -> @Timer</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Runs the `cb` function every specified amount of `time`.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#multiprompt">multiprompt(str)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Changes the text prompt when Hilbish asks for more input.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#prependPath">prependPath(dir)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Prepends `dir` to $PATH.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#prompt">prompt(str, typ)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Changes the shell prompt to the provided string.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#read">read(prompt) -> input (string)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Read input from the user, using Hilbish's line editor/input reader.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#timeout">timeout(cb, time) -> @Timer</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Executed the `cb` function after a period of `time`.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#which">which(name) -> string</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Checks if `name` is a valid command.</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Static-module-fields">Static module fields</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
<table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
<tbody>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>ver</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>The version of Hilbish</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>goVersion</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>The version of Go that Hilbish was compiled with</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>user</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Username of the user</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>host</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Hostname of the machine</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>dataDir</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Directory for Hilbish data files, including the docs and default modules</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>interactive</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Is Hilbish in an interactive shell?</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>login</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Is Hilbish the login shell?</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>vimMode</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Current Vim input mode of Hilbish (will be nil if not in Vim input mode)</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>exitCode</td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Exit code of the last executed command</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='alias'>
<h4 class='text-xl font-medium mb-2'>
hilbish.alias(cmd, orig) hilbish.alias(cmd, orig)
&lt;a href=&quot;#alias&quot; class=&#39;heading-link&#39;&gt; <a href="#alias" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Sets an alias, with a name of <code>cmd</code> to another command. </p><p class="font-bold text-xl" id="Parameters-string-**cmd**---Name-of-the-alias">Parameters </h4></div><p>Sets an alias, with a name of <code class="text-violet-600 dark:text-violet-400">cmd</code> to another command. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*cmd*</code>
<code>string</code> **<code>cmd</code>** Name of the alias</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*orig*</code>
Name of the alias</p><p><code>string</code> **<code>orig</code>** Command that will be aliased</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Example">Example</p><pre><code data-lang="lua">-- With this, &quot;ga file&quot; will turn into &quot;git add file&quot;
Command that will be aliased</p><p class="font-bold text-xl" id="Example-lua----With-this-&quot;ga-file&quot;-will-turn-into-&quot;git-add-file&quot;-hilbish.alias(&#39;ga&#39;-&#39;git-add&#39;)">Example hilbish.alias(&#39;ga&#39;, &#39;git add&#39;)
<code>lua
-- With this, &quot;ga file&quot; will turn into &quot;git add file&quot; -- Numbered substitutions are supported here!
hilbish.alias(&#39;ga&#39;, &#39;git add&#39;)</code></p><p>-- Numbered substitutions are supported here!
hilbish.alias(&#39;dircount&#39;, &#39;ls %1 | wc -l&#39;) hilbish.alias(&#39;dircount&#39;, &#39;ls %1 | wc -l&#39;)
-- &quot;dircount ~&quot; would count how many files are in ~ (home directory). -- &quot;dircount ~&quot; would count how many files are in ~ (home directory).
<code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</code></p><p>&lt;hr&gt; <div id='appendPath'>
&lt;div id=&#39;appendPath&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.appendPath(dir) hilbish.appendPath(dir)
&lt;a href=&quot;#appendPath&quot; class=&#39;heading-link&#39;&gt; <a href="#appendPath" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Appends the provided dir to the command path (<code>$PATH</code>) </p><p class="font-bold text-xl" id="Parameters-string|table-**dir**---Directory-(or-directories)-to-append-to-path">Parameters </h4></div><p>Appends the provided dir to the command path (<code class="text-violet-600 dark:text-violet-400">$PATH</code>) </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string|table</code> <code class="text-violet-600 dark:text-violet-400">*dir*</code>
<code>string|table</code> **<code>dir</code>** Directory (or directories) to append to path</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">hilbish.appendPath &#39;~/go/bin&#39;
Directory (or directories) to append to path</p><p class="font-bold text-xl" id="Example-lua-hilbish.appendPath-&#39;~/go/bin&#39;----Will-add-~/go/bin-to-the-command-path.">Example -- Will add ~/go/bin to the command path.
<code>lua
hilbish.appendPath &#39;~/go/bin&#39; -- Or do multiple:
-- Will add ~/go/bin to the command path.</code></p><p>-- Or do multiple:
hilbish.appendPath { hilbish.appendPath {
&#39;~/go/bin&#39;, &#39;~/go/bin&#39;,
&#39;~/.local/bin&#39; &#39;~/.local/bin&#39;
} }
<code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</code></p><p>&lt;hr&gt; <div id='complete'>
&lt;div id=&#39;complete&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.complete(scope, cb) hilbish.complete(scope, cb)
&lt;a href=&quot;#complete&quot; class=&#39;heading-link&#39;&gt; <a href="#complete" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Registers a completion handler for the specified scope. </h4></div><p>Registers a completion handler for the specified scope.
A <code>scope</code> is expected to be <code>command.&lt;cmd&gt;</code>, A <code class="text-violet-600 dark:text-violet-400">scope</code> is expected to be <code class="text-violet-600 dark:text-violet-400">command.&lt;cmd&gt;</code>,
replacing &lt;cmd&gt; with the name of the command (for example <code>command.git</code>). replacing &lt;cmd&gt; with the name of the command (for example <code class="text-violet-600 dark:text-violet-400">command.git</code>).
The documentation for completions, under Features/Completions or <code>doc completions</code> The documentation for completions, under Features/Completions or <code class="text-violet-600 dark:text-violet-400">doc completions</code>
provides more details. </p><p class="font-bold text-xl" id="Parameters-string-**scope**">Parameters provides more details. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*scope*</code> </p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*cb*</code> </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">-- This is a very simple example. Read the full doc for completions for details.
<code>string</code> **<code>scope</code>** </p><p><code>function</code> **<code>cb</code>** </p><p class="font-bold text-xl" id="Example-lua----This-is-a-very-simple-example.-Read-the-full-doc-for-completions-for-details.-hilbish.complete(&#39;command.sudo&#39;-function(query-ctx-fields)- if-fields-==-0-then- ---complete-for-commands- local-comps-pfx-=-hilbish.completion.bins(query-ctx-fields)- local-compGroup-=-{- items-=-comps----our-list-of-items-to-complete- type-=-&#39;grid&#39;----what-our-completions-will-look-like.- }">Example
<code>lua
-- This is a very simple example. Read the full doc for completions for details.
hilbish.complete(&#39;command.sudo&#39;, function(query, ctx, fields) hilbish.complete(&#39;command.sudo&#39;, function(query, ctx, fields)
if #fields == 0 then if #fields == 0 then
-- complete for commands -- complete for commands
@ -89,238 +160,170 @@ hilbish.complete(&#39;command.sudo&#39;, function(query, ctx, fields)
local compGroup = { local compGroup = {
items = comps, -- our list of items to complete items = comps, -- our list of items to complete
type = &#39;grid&#39; -- what our completions will look like. type = &#39;grid&#39; -- what our completions will look like.
}</code></p><p> return {compGroup}, pfx }
end</p><p> -- otherwise just be boring and return files</p><p> local comps, pfx = hilbish.completion.files(query, ctx, fields)
return {compGroup}, pfx
end
-- otherwise just be boring and return files
local comps, pfx = hilbish.completion.files(query, ctx, fields)
local compGroup = { local compGroup = {
items = comps, items = comps,
type = &#39;grid&#39; type = &#39;grid&#39;
}</p><p> return {compGroup}, pfx }
return {compGroup}, pfx
end) end)
<code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</code></p><p>&lt;hr&gt; <div id='cwd'>
&lt;div id=&#39;cwd&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; hilbish.cwd() -> string
hilbish.cwd() -&gt; string <a href="#cwd" class='heading-link'>
&lt;a href=&quot;#cwd&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Returns the current directory of the shell. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p>This function has no parameters. </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/h4&gt;</p><p>Returns the current directory of the shell. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters <div id='exec'>
This function has no parameters. <h4 class='text-xl font-medium mb-2'>
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;exec&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.exec(cmd) hilbish.exec(cmd)
&lt;a href=&quot;#exec&quot; class=&#39;heading-link&#39;&gt; <a href="#exec" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Replaces the currently running Hilbish instance with the supplied command. </h4></div><p>Replaces the currently running Hilbish instance with the supplied command.
This can be used to do an in-place restart. </p><p class="font-bold text-xl" id="Parameters-string-**cmd**">Parameters This can be used to do an in-place restart. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*cmd*</code> </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>string</code> **<code>cmd</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='goro'>
&lt;div id=&#39;goro&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.goro(fn) hilbish.goro(fn)
&lt;a href=&quot;#goro&quot; class=&#39;heading-link&#39;&gt; <a href="#goro" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Puts <code>fn</code> in a Goroutine. </h4></div><p>Puts <code class="text-violet-600 dark:text-violet-400">fn</code> in a Goroutine.
This can be used to run any function in another thread at the same time as other Lua code. This can be used to run any function in another thread at the same time as other Lua code.
*<strong>NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.</strong>* *<strong>NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.</strong>*
*<strong>This is a limitation of the Lua runtime.</strong>* </p><p class="font-bold text-xl" id="Parameters-function-**fn**">Parameters *<strong>This is a limitation of the Lua runtime.</strong>* </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*fn*</code> </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>function</code> **<code>fn</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='highlighter'>
&lt;div id=&#39;highlighter&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.highlighter(line) hilbish.highlighter(line)
&lt;a href=&quot;#highlighter&quot; class=&#39;heading-link&#39;&gt; <a href="#highlighter" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Line highlighter handler. </h4></div><p>Line highlighter handler.
This is mainly for syntax highlighting, but in reality could set the input This is mainly for syntax highlighting, but in reality could set the input
of the prompt to <strong>display</strong> anything. The callback is passed the current line of the prompt to <strong>display</strong> anything. The callback is passed the current line
and is expected to return a line that will be used as the input display. and is expected to return a line that will be used as the input display.
Note that to set a highlighter, one has to override this function. </p><p class="font-bold text-xl" id="Parameters-string-**line**">Parameters Note that to set a highlighter, one has to override this function. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*line*</code> </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">--This code will highlight all double quoted strings in green.
<code>string</code> **<code>line</code>** </p><p class="font-bold text-xl" id="Example-lua---This-code-will-highlight-all-double-quoted-strings-in-green.-function-hilbish.highlighter(line)----return-line:gsub(&#39;&quot;%w+&quot;&#39;-function(c)-return-lunacolors.green(c)-end)-end--&lt;/div&gt;">Example
<code>lua
--This code will highlight all double quoted strings in green.
function hilbish.highlighter(line) function hilbish.highlighter(line)
return line:gsub(&#39;&quot;%w+&quot;&#39;, function(c) return lunacolors.green(c) end) return line:gsub(&#39;&quot;%w+&quot;&#39;, function(c) return lunacolors.green(c) end)
end end
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='hinter'>
&lt;div id=&#39;hinter&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.hinter(line, pos) hilbish.hinter(line, pos)
&lt;a href=&quot;#hinter&quot; class=&#39;heading-link&#39;&gt; <a href="#hinter" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>The command line hint handler. It gets called on every key insert to </h4></div><p>The command line hint handler. It gets called on every key insert to
determine what text to use as an inline hint. It is passed the current determine what text to use as an inline hint. It is passed the current
line and cursor position. It is expected to return a string which is used line and cursor position. It is expected to return a string which is used
as the text for the hint. This is by default a shim. To set hints, as the text for the hint. This is by default a shim. To set hints,
override this function with your custom handler. </p><p class="font-bold text-xl">Parameters override this function with your custom handler. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*line*</code> </p><p><code class="text-violet-600 dark:text-violet-400">number</code> <code class="text-violet-600 dark:text-violet-400">*pos*</code>
<code>string</code> **<code>line</code>** </p><p><code>number</code> **<code>pos</code>** Position of cursor in line. Usually equals string.len(line)</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">-- this will display &quot;hi&quot; after the cursor in a dimmed color.
Position of cursor in line. Usually equals string.len(line)</p><p class="font-bold text-xl" id="Example-lua----this-will-display-&quot;hi&quot;-after-the-cursor-in-a-dimmed-color.-function-hilbish.hinter(line-pos)- return-&#39;hi&#39;-end--&lt;/div&gt;">Example
<code>lua
-- this will display &quot;hi&quot; after the cursor in a dimmed color.
function hilbish.hinter(line, pos) function hilbish.hinter(line, pos)
return &#39;hi&#39; return &#39;hi&#39;
end end
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='inputMode'>
&lt;div id=&#39;inputMode&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.inputMode(mode) hilbish.inputMode(mode)
&lt;a href=&quot;#inputMode&quot; class=&#39;heading-link&#39;&gt; <a href="#inputMode" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Sets the input mode for Hilbish&#39;s line reader. </h4></div><p>Sets the input mode for Hilbish&#39;s line reader.
<code>emacs</code> is the default. Setting it to <code>vim</code> changes behavior of input to be <code class="text-violet-600 dark:text-violet-400">emacs</code> is the default. Setting it to <code class="text-violet-600 dark:text-violet-400">vim</code> changes behavior of input to be
Vim-like with modes and Vim keybinds. </p><p class="font-bold text-xl" id="Parameters-string-**mode**---Can-be-set-to-either-emacs-or-vim">Parameters Vim-like with modes and Vim keybinds. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*mode*</code>
<code>string</code> **<code>mode</code>** Can be set to either <code class="text-violet-600 dark:text-violet-400">emacs</code> or <code class="text-violet-600 dark:text-violet-400">vim</code></p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
Can be set to either <code>emacs</code> or <code>vim</code></p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='interval'>
&lt;div id=&#39;interval&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; hilbish.interval(cb, time) -> @Timer
hilbish.interval(cb, time) -&gt; &lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.timers/#timer&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Timer&lt;/a&gt; <a href="#interval" class='heading-link'>
&lt;a href=&quot;#interval&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Runs the <code class="text-violet-600 dark:text-violet-400">cb</code> function every specified amount of <code class="text-violet-600 dark:text-violet-400">time</code>.
&lt;/h4&gt;</p><p>Runs the <code>cb</code> function every specified amount of <code>time</code>. This creates a timer that ticking immediately. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*cb*</code> </p><p><code class="text-violet-600 dark:text-violet-400">number</code> <code class="text-violet-600 dark:text-violet-400">*time*</code>
This creates a timer that ticking immediately. </p><p class="font-bold text-xl" id="Parameters-function-**cb**">Parameters Time in milliseconds.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>function</code> **<code>cb</code>** </p><p><code>number</code> **<code>time</code>** <div id='multiprompt'>
Time in milliseconds.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;multiprompt&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.multiprompt(str) hilbish.multiprompt(str)
&lt;a href=&quot;#multiprompt&quot; class=&#39;heading-link&#39;&gt; <a href="#multiprompt" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Changes the text prompt when Hilbish asks for more input. </h4></div><p>Changes the text prompt when Hilbish asks for more input.
This will show up when text is incomplete, like a missing quote </p><p class="font-bold text-xl" id="Parameters-string-**str**">Parameters This will show up when text is incomplete, like a missing quote </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*str*</code> </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">--[[
<code>string</code> **<code>str</code>** </p><p class="font-bold text-xl" id="Example-lua---[[-imagine-this-is-your-text-input:-user-~-∆-echo-&quot;hey">Example
<code>lua
--[[
imagine this is your text input: imagine this is your text input:
user ~ ∆ echo &quot;hey</code></p><p>but there&#39;s a missing quote! hilbish will now prompt you so the terminal user ~ ∆ echo &quot;hey
but there&#39;s a missing quote! hilbish will now prompt you so the terminal
will look like: will look like:
user ~ ∆ echo &quot;hey user ~ ∆ echo &quot;hey
--&gt; ...!&quot;</p><p>so then you get --&gt; ...!&quot;
so then you get
user ~ ∆ echo &quot;hey user ~ ∆ echo &quot;hey
--&gt; ...!&quot; --&gt; ...!&quot;
hey ...! hey ...!
]]-- ]]--
hilbish.multiprompt &#39;--&gt;&#39; hilbish.multiprompt &#39;--&gt;&#39;
<code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</code></p><p>&lt;hr&gt; <div id='prependPath'>
&lt;div id=&#39;prependPath&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.prependPath(dir) hilbish.prependPath(dir)
&lt;a href=&quot;#prependPath&quot; class=&#39;heading-link&#39;&gt; <a href="#prependPath" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Prepends <code>dir</code> to $PATH. </p><p class="font-bold text-xl" id="Parameters-string-**dir**">Parameters </h4></div><p>Prepends <code class="text-violet-600 dark:text-violet-400">dir</code> to $PATH. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*dir*</code> </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>string</code> **<code>dir</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='prompt'>
&lt;div id=&#39;prompt&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.prompt(str, typ) hilbish.prompt(str, typ)
&lt;a href=&quot;#prompt&quot; class=&#39;heading-link&#39;&gt; <a href="#prompt" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Changes the shell prompt to the provided string. </h4></div><p>Changes the shell prompt to the provided string.
There are a few verbs that can be used in the prompt text. There are a few verbs that can be used in the prompt text.
These will be formatted and replaced with the appropriate values. These will be formatted and replaced with the appropriate values.
<code>%d</code> - Current working directory <code class="text-violet-600 dark:text-violet-400">%d</code> - Current working directory
<code>%u</code> - Name of current user <code class="text-violet-600 dark:text-violet-400">%u</code> - Name of current user
<code>%h</code> - Hostname of device </p><p class="font-bold text-xl">Parameters <code class="text-violet-600 dark:text-violet-400">%h</code> - Hostname of device </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*str*</code> </p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*typ?*</code>
<code>string</code> **<code>str</code>** </p><p><code>string</code> **<code>typ?</code>** Type of prompt, being left or right. Left by default.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</p><pre><code data-lang="lua">-- the default hilbish prompt without color
Type of prompt, being left or right. Left by default.</p><p class="font-bold text-xl" id="Example-lua----the-default-hilbish-prompt-without-color-hilbish.prompt-&#39;%u-%d-∆&#39;----or-something-of-old:-hilbish.prompt-&#39;%u@%h-:%d-$&#39;----prompt:-user@hostname:-~/directory-$--&lt;/div&gt;">Example
<code>lua
-- the default hilbish prompt without color
hilbish.prompt &#39;%u %d ∆&#39; hilbish.prompt &#39;%u %d ∆&#39;
-- or something of old: -- or something of old:
hilbish.prompt &#39;%u@%h :%d $&#39; hilbish.prompt &#39;%u@%h :%d $&#39;
-- prompt: user@hostname: ~/directory $ -- prompt: user@hostname: ~/directory $
</code> </code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/div&gt;</p><p>&lt;hr&gt; <div id='read'>
&lt;div id=&#39;read&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; hilbish.read(prompt) -> input (string)
hilbish.read(prompt) -&gt; input (string) <a href="#read" class='heading-link'>
&lt;a href=&quot;#read&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Read input from the user, using Hilbish&#39;s line editor/input reader.
&lt;/h4&gt;</p><p>Read input from the user, using Hilbish&#39;s line editor/input reader.
This is a separate instance from the one Hilbish actually uses. This is a separate instance from the one Hilbish actually uses.
Returns <code>input</code>, will be nil if Ctrl-D is pressed, or an error occurs. </p><p class="font-bold text-xl" id="Parameters-string-**prompt**---Text-to-print-before-input-can-be-empty.">Parameters Returns <code class="text-violet-600 dark:text-violet-400">input</code>, will be nil if Ctrl-D is pressed, or an error occurs. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*prompt?*</code>
<code>string</code> **<code>prompt?</code>** Text to print before input, can be empty.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
Text to print before input, can be empty.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <div id='timeout'>
&lt;div id=&#39;timeout&#39;&gt; <h4 class='text-xl font-medium mb-2'>
&lt;h4 class=&#39;heading&#39;&gt; hilbish.timeout(cb, time) -> @Timer
hilbish.timeout(cb, time) -&gt; &lt;a href=&quot;/Hilbish/docs/api/hilbish/hilbish.timers/#timer&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Timer&lt;/a&gt; <a href="#timeout" class='heading-link'>
&lt;a href=&quot;#timeout&quot; class=&#39;heading-link&#39;&gt; <i class="fas fa-paperclip"></i>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </a>
&lt;/a&gt; </h4></div><p>Executed the <code class="text-violet-600 dark:text-violet-400">cb</code> function after a period of <code class="text-violet-600 dark:text-violet-400">time</code>.
&lt;/h4&gt;</p><p>Executed the <code>cb</code> function after a period of <code>time</code>. This creates a Timer that starts ticking immediately. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <code class="text-violet-600 dark:text-violet-400">*cb*</code> </p><p><code class="text-violet-600 dark:text-violet-400">number</code> <code class="text-violet-600 dark:text-violet-400">*time*</code>
This creates a Timer that starts ticking immediately. </p><p class="font-bold text-xl">Parameters Time to run in milliseconds.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<code>function</code> **<code>cb</code>** </p><p><code>number</code> **<code>time</code>** <div id='which'>
Time to run in milliseconds.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;which&#39;&gt; hilbish.which(name) -> string
&lt;h4 class=&#39;heading&#39;&gt; <a href="#which" class='heading-link'>
hilbish.which(name) -&gt; string <i class="fas fa-paperclip"></i>
&lt;a href=&quot;#which&quot; class=&#39;heading-link&#39;&gt; </a>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </h4></div><p>Checks if <code class="text-violet-600 dark:text-violet-400">name</code> is a valid command.
&lt;/a&gt; Will return the path of the binary, or a basename if it&#39;s a commander. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p><code class="text-violet-600 dark:text-violet-400">string</code> <code class="text-violet-600 dark:text-violet-400">*name*</code> </p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Types">Types</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Sink">Sink</h2><p>A sink is a structure that has input and/or output to/from a desination.</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="Methods">Methods</h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="autoFlush(auto)">autoFlush(auto)</p><p>Sets/toggles the option of automatically flushing output.
&lt;/h4&gt;</p><p>Checks if <code>name</code> is a valid command. A call with no argument will toggle the value.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="flush()">flush()</p><p>Flush writes all buffered input to the sink.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="read()--&gt;-string">read() -&gt; string</p><p>Reads a liine of input from the sink.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="readAll()--&gt;-string">readAll() -&gt; string</p><p>Reads all input from the sink.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="write(str)">write(str)</p><p>Writes data to a sink.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="writeln(str)">writeln(str)</p><p>Writes data to a sink with a newline at the end.</p></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="http://localhost:9080"><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>
Will return the path of the binary, or a basename if it&#39;s a commander. </p><p class="font-bold text-xl" id="Parameters-string-**name**">Parameters
<code>string</code> **<code>name</code>** </p><p>&lt;/div&gt;</p><h2 class="font-bold text-3xl" id="Types-&lt;hr&gt;">Types
&lt;hr&gt;</h2><h2 class="font-bold text-3xl" id="Sink-A-sink-is-a-structure-that-has-input-and/or-output-to/from-a-desination.">Sink
A sink is a structure that has input and/or output to/from a desination.</h2><h3 class="font-bold text-2xl" id="Methods">Methods</h3><p class="font-bold text-xl" id="autoFlush(auto)-Sets/toggles-the-option-of-automatically-flushing-output.-A-call-with-no-argument-will-toggle-the-value.">autoFlush(auto)
Sets/toggles the option of automatically flushing output.
A call with no argument will toggle the value.</p><p class="font-bold text-xl" id="flush()-Flush-writes-all-buffered-input-to-the-sink.">flush()
Flush writes all buffered input to the sink.</p><p class="font-bold text-xl" id="read()--&gt;-string-Reads-a-liine-of-input-from-the-sink.">read() -&gt; string
Reads a liine of input from the sink.</p><p class="font-bold text-xl" id="readAll()--&gt;-string-Reads-all-input-from-the-sink.">readAll() -&gt; string
Reads all input from the sink.</p><p class="font-bold text-xl" id="write(str)-Writes-data-to-a-sink.">write(str)
Writes data to a sink.</p><p class="font-bold text-xl" id="writeln(str)-Writes-data-to-a-sink-with-a-newline-at-the-end.">writeln(str)
Writes data to a sink with a newline at the end.</p><p>&lt;hr&gt;
&lt;div id=&#39;run&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.run(cmd, streams)
&lt;a href=&quot;#run&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Runs <code>cmd</code> in Hilbish&#39;s shell script interpreter.
The <code>streams</code> parameter specifies the output and input streams the command should use.
For example, to write command output to a sink.
As a table, the caller can directly specify the standard output, error, and input
streams of the command with the table keys <code>out</code>, <code>err</code>, and <code>input</code> respectively.
As a boolean, it specifies whether the command should use standard output or return its output streams.
#### Parameters
<code>cmd</code> **<code>string</code>** </p><p><code>streams</code> **<code>table|boolean</code>** </p><p class="font-bold text-xl" id="Example-lua----This-code-is-the-same-as-`ls--l-|-wc--l`-local-fs-=-require-&#39;fs&#39;-local-pr-pw-=-fs.pipe()-hilbish.run(&#39;ls--l&#39;-{- stdout-=-pw- stderr-=-pw-})-pw:close()-hilbish.run(&#39;wc--l&#39;-{- stdin-=-pr-})--&lt;/div&gt;">Example
<code>lua
-- This code is the same as `ls -l | wc -l`
local fs = require &#39;fs&#39;
local pr, pw = fs.pipe()
hilbish.run(&#39;ls -l&#39;, {
stdout = pw,
stderr = pw,
})
pw:close()
hilbish.run(&#39;wc -l&#39;, {
stdin = pr
})
</code>
&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;runnerMode&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
hilbish.runnerMode(mode)
&lt;a href=&quot;#runnerMode&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Sets the execution/runner mode for interactive Hilbish.
*<strong>NOTE: This function is deprecated and will be removed in 3.0</strong>*
Use <code>hilbish.runner.setCurrent</code> instead.
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.
Read <a href="../features/runner-mode">about runner mode</a> for more information.
#### Parameters
<code>mode</code> **<code>string|function</code>** </p><p>&lt;/div&gt;</p></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>

3
versions/new-website/docs/api/index.html
View File

@ -1,3 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>API</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">API</h1><p>Welcome to the API documentation for Hilbish. This documents Lua functions
provided by Hilbish.</p></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>

38
versions/new-website/docs/api/snail/index.html
View File

@ -1,22 +1,22 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module snail</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module snail</h1><h2 class="font-bold text-3xl" id="Introduction">Introduction</h2><p>The snail library houses Hilbish&#39;s Lua wrapper of its shell script interpreter. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module snail</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module snail</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>The snail library houses Hilbish&#39;s Lua wrapper of its shell script interpreter.
It&#39;s not very useful other than running shell scripts, which can be done with other It&#39;s not very useful other than running shell scripts, which can be done with other
Hilbish functions.</p><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;new&quot;&gt;new()--&gt;-@Snail&lt;/a&gt;|Creates-a-new-Snail-instance.|">Functions Hilbish functions.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
||| <table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
|----|----| <tbody>
|&lt;a href=&quot;#new&quot;&gt;new() -&gt; @Snail&lt;/a&gt;|Creates a new Snail instance.|</h2><p>&lt;hr&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;div id=&#39;new&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#new">new() -> @Snail</a></td>
&lt;h4 class=&#39;heading&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Creates a new Snail instance.</td>
snail.new() -&gt; &lt;a href=&quot;/Hilbish/docs/api/snail/#snail&quot; style=&quot;text-decoration: none;&quot; id=&quot;lol&quot;&gt;Snail&lt;/a&gt; </tr>
&lt;a href=&quot;#new&quot; class=&#39;heading-link&#39;&gt; </tbody>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; </table>
&lt;/a&gt; </div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
&lt;/h4&gt;</p><p>Creates a new Snail instance. </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters <div id='new'>
This function has no parameters. <h4 class='text-xl font-medium mb-2'>
&lt;/div&gt;</p><h2 class="font-bold text-3xl" id="Types-&lt;hr&gt;">Types snail.new() -> @Snail
&lt;hr&gt;</h2><h2 class="font-bold text-3xl" id="Snail-A-Snail-is-a-shell-script-interpreter-instance.">Snail <a href="#new" class='heading-link'>
A Snail is a shell script interpreter instance.</h2><h3 class="font-bold text-2xl" id="Methods">Methods</h3><p class="font-bold text-xl" id="dir(path)-Changes-the-directory-of-the-snail-instance.-The-interpreter-keeps-its-set-directory-even-when-the-Hilbish-process-changes-directory-so-this-should-be-called-on-the-hilbish.cd-hook.">dir(path) <i class="fas fa-paperclip"></i>
Changes the directory of the snail instance. </a>
</h4></div><p>Creates a new Snail instance. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</p><p>This function has no parameters. </p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Types">Types</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Snail">Snail</h2><p>A Snail is a shell script interpreter instance.</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="Methods">Methods</h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="dir(path)">dir(path)</p><p>Changes the directory of the snail instance.
The interpreter keeps its set directory even when the Hilbish process changes The interpreter keeps its set directory even when the Hilbish process changes
directory, so this should be called on the <code>hilbish.cd</code> hook.</p><p class="font-bold text-xl" id="run(command-streams)-Runs-a-shell-command.-Works-the-same-as-hilbish.run-but-only-accepts-a-table-of-streams.">run(command, streams) directory, so this should be called on the <code class="text-violet-600 dark:text-violet-400">hilbish.cd</code> hook.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="run(command-streams)">run(command, streams)</p><p>Runs a shell command. Works the same as <code class="text-violet-600 dark:text-violet-400">hilbish.run</code>, but only accepts a table of streams.</p></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="http://localhost:9080"><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>
Runs a shell command. Works the same as <code>hilbish.run</code>, but only accepts a table of streams.</p></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>

88
versions/new-website/docs/api/terminal/index.html
View File

@ -1,46 +1,52 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module terminal</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module terminal</h1><h2 class="font-bold text-3xl" id="Introduction-The-terminal-library-is-a-simple-and-lower-level-library-for-certain-terminal-interactions.">Introduction <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module terminal</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module terminal</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>The terminal library is a simple and lower level library for certain terminal interactions.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
The terminal library is a simple and lower level library for certain terminal interactions.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;restoreState&quot;&gt;restoreState()&lt;/a&gt;|Restores-the-last-saved-state-of-the-terminal|-|&lt;a-href=&quot;saveState&quot;&gt;saveState()&lt;/a&gt;|Saves-the-current-state-of-the-terminal.|-|&lt;a-href=&quot;setRaw&quot;&gt;setRaw()&lt;/a&gt;|Puts-the-terminal-into-raw-mode.|-|&lt;a-href=&quot;size&quot;&gt;size()&lt;/a&gt;|Gets-the-dimensions-of-the-terminal.-Returns-a-table-with-width-and-height|">Functions <table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
||| <tbody>
|----|----| <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
|&lt;a href=&quot;#restoreState&quot;&gt;restoreState()&lt;/a&gt;|Restores the last saved state of the terminal| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#restoreState">restoreState()</a></td>
|&lt;a href=&quot;#saveState&quot;&gt;saveState()&lt;/a&gt;|Saves the current state of the terminal.| <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Restores the last saved state of the terminal</td>
|&lt;a href=&quot;#setRaw&quot;&gt;setRaw()&lt;/a&gt;|Puts the terminal into raw mode.| </tr>
|&lt;a href=&quot;#size&quot;&gt;size()&lt;/a&gt;|Gets the dimensions of the terminal. Returns a table with <code>width</code> and <code>height</code>|</h2><p>&lt;hr&gt; <tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
&lt;div id=&#39;restoreState&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#saveState">saveState()</a></td>
&lt;h4 class=&#39;heading&#39;&gt; <td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Saves the current state of the terminal.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#setRaw">setRaw()</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Puts the terminal into raw mode.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#size">size()</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Gets the dimensions of the terminal. Returns a table with `width` and `height`</td>
</tr>
</tbody>
</table>
</div></div><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='restoreState'>
<h4 class='text-xl font-medium mb-2'>
terminal.restoreState() terminal.restoreState()
&lt;a href=&quot;#restoreState&quot; class=&#39;heading-link&#39;&gt; <a href="#restoreState" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Restores the last saved state of the terminal </p><p class="font-bold text-xl" id="Parameters-This-function-has-no-parameters.---&lt;/div&gt;">Parameters </h4></div><p>Restores the last saved state of the terminal </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</p><p>This function has no parameters. </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
This function has no parameters. <div id='saveState'>
&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;saveState&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
terminal.saveState() terminal.saveState()
&lt;a href=&quot;#saveState&quot; class=&#39;heading-link&#39;&gt; <a href="#saveState" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Saves the current state of the terminal. </p><p class="font-bold text-xl">Parameters </h4></div><p>Saves the current state of the terminal. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p>This function has no parameters. </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
This function has no parameters. <div id='setRaw'>
&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;setRaw&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
terminal.setRaw() terminal.setRaw()
&lt;a href=&quot;#setRaw&quot; class=&#39;heading-link&#39;&gt; <a href="#setRaw" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Puts the terminal into raw mode. </p><p class="font-bold text-xl">Parameters </h4></div><p>Puts the terminal into raw mode. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p>This function has no parameters. </p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
This function has no parameters. <div id='size'>
&lt;/div&gt;</p><p>&lt;hr&gt; <h4 class='text-xl font-medium mb-2'>
&lt;div id=&#39;size&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
terminal.size() terminal.size()
&lt;a href=&quot;#size&quot; class=&#39;heading-link&#39;&gt; <a href="#size" class='heading-link'>
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; <i class="fas fa-paperclip"></i>
&lt;/a&gt; </a>
&lt;/h4&gt;</p><p>Gets the dimensions of the terminal. Returns a table with <code>width</code> and <code>height</code> </h4></div><p>Gets the dimensions of the terminal. Returns a table with <code class="text-violet-600 dark:text-violet-400">width</code> and <code class="text-violet-600 dark:text-violet-400">height</code>
NOTE: The size refers to the amount of columns and rows of text that can fit in the terminal. </p><p class="font-bold text-xl">Parameters NOTE: The size refers to the amount of columns and rows of text that can fit in the terminal. </p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</p><p>This function has no parameters. </p></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="http://localhost:9080"><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>
This function has no parameters.
&lt;/div&gt;</p></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>

44
versions/new-website/docs/completions/index.html
View File

@ -1,23 +1,23 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Completions</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Completions</h1><p>Completions for commands can be created with the <a href="../api/hilbish#complete"><code>hilbish.complete</code></a> <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Completions</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Completions</h1><p>Completions for commands can be created with the <a href="../api/hilbish#complete"><code class="text-violet-600 dark:text-violet-400">hilbish.complete</code></a>
function. See the link for how to use it.</p><p>To create completions for a command is simple. function. See the link for how to use it.</p><p>To create completions for a command is simple.
The callback will be passed 3 parameters: The callback will be passed 3 parameters:
- <code>query</code> (string): The text that the user is currently trying to complete. - <code class="text-violet-600 dark:text-violet-400">query</code> (string): The text that the user is currently trying to complete.
This should be used to match entries. This should be used to match entries.
- <code>ctx</code> (string): Contains the entire line. Use this if - <code class="text-violet-600 dark:text-violet-400">ctx</code> (string): Contains the entire line. Use this if
more text is needed to be parsed for context. more text is needed to be parsed for context.
- <code>fields</code> (string): The <code>ctx</code> split up by spaces.</p><p>In most cases, the completer just uses <code>fields</code> to check the amount - <code class="text-violet-600 dark:text-violet-400">fields</code> (string): The <code class="text-violet-600 dark:text-violet-400">ctx</code> split up by spaces.</p><p>In most cases, the completer just uses <code class="text-violet-600 dark:text-violet-400">fields</code> to check the amount
and <code>query</code> on what to match entries on.</p><p>In order to return your results, it has to go within a &quot;completion group.&quot; and <code class="text-violet-600 dark:text-violet-400">query</code> on what to match entries on.</p><p>In order to return your results, it has to go within a &quot;completion group.&quot;
Then you return a table of completion groups and a prefix. The prefix will Then you return a table of completion groups and a prefix. The prefix will
usually just be the <code>query</code>.</p><p>Hilbish allows one to mix completion menus of different types, so usually just be the <code class="text-violet-600 dark:text-violet-400">query</code>.</p><p>Hilbish allows one to mix completion menus of different types, so
a grid menu and a list menu can be used and complete and display at the same time. a grid menu and a list menu can be used and complete and display at the same time.
A completion group is a table with these keys: A completion group is a table with these keys:
- <code>type</code> (string): type of completion menu, either <code>grid</code> or <code>list</code>. - <code class="text-violet-600 dark:text-violet-400">type</code> (string): type of completion menu, either <code class="text-violet-600 dark:text-violet-400">grid</code> or <code class="text-violet-600 dark:text-violet-400">list</code>.
- <code>items</code> (table): a list of items. </p><p>The requirements of the <code>items</code> table is different based on the - <code class="text-violet-600 dark:text-violet-400">items</code> (table): a list of items. </p><p>The requirements of the <code class="text-violet-600 dark:text-violet-400">items</code> table is different based on the
<code>type</code>. If it is a <code>grid</code>, it can simply be a table of strings.</p><p>Otherwise if it is a <code>list</code> then each entry can <code class="text-violet-600 dark:text-violet-400">type</code>. If it is a <code class="text-violet-600 dark:text-violet-400">grid</code>, it can simply be a table of strings.</p><p>Otherwise if it is a <code class="text-violet-600 dark:text-violet-400">list</code> then each entry can
either be a string or a table. either be a string or a table.
Example: Example:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
local cg = { local cg = {
items = { items = {
&#39;list item 1&#39;, &#39;list item 1&#39;,
@ -29,22 +29,22 @@ local cg2 = {
items = {&#39;just&#39;, &#39;a bunch&#39;, &#39;of items&#39;, &#39;here&#39;, &#39;hehe&#39;}, items = {&#39;just&#39;, &#39;a bunch&#39;, &#39;of items&#39;, &#39;here&#39;, &#39;hehe&#39;},
type = &#39;grid&#39; type = &#39;grid&#39;
}</code></p><p>return {cg, cg2}, prefix }</code></p><p>return {cg, cg2}, prefix
<code></code></p><p>Which looks like this: <code class="text-violet-600 dark:text-violet-400"></code></p><p>Which looks like this:
{{&lt; video src=&quot;https://safe.saya.moe/t4CiLK6dgPbD.mp4&quot; &gt;}}</p><h1 class="font-bold text-4xl" id="Completion-Group-Types">Completion Group Types</h1><h3 class="font-bold text-2xl" id="grid-Grid-is-the-simplest-completion-group-type.-All-items-are-strings-and-when-completion-is-done-is-displayed-in-a-grid-based-on-size.">grid {{&lt; video src=&quot;https://safe.saya.moe/t4CiLK6dgPbD.mp4&quot; &gt;}}</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Completion-Group-Types">Completion Group Types</h1><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="grid-Grid-is-the-simplest-completion-group-type.-All-items-are-strings-and-when-completion-is-done-is-displayed-in-a-grid-based-on-size.">grid
Grid is the simplest completion group type. All items are strings and when Grid is the simplest completion group type. All items are strings and when
completion is done is displayed in a grid based on size.</h3><p>Example: completion is done is displayed in a grid based on size.</h3><p>Example:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
{ {
items = {&#39;just&#39;, &#39;a bunch&#39;, &#39;of items&#39;, &#39;here&#39;, &#39;hehe&#39;}, items = {&#39;just&#39;, &#39;a bunch&#39;, &#39;of items&#39;, &#39;here&#39;, &#39;hehe&#39;},
type = &#39;grid&#39; type = &#39;grid&#39;
} }
</code></p><h3 class="font-bold text-2xl" id="list-The-list-completion-group-type-displays-in-a-list.-A-list-item-can-either-be-a-string-or-a-table-for-additional-display-options.-A-completion-alias-can-be-specified-either-as-the-2nd-entry-in-the-options-table-or-te-alias-key.">list </code></p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="list-The-list-completion-group-type-displays-in-a-list.-A-list-item-can-either-be-a-string-or-a-table-for-additional-display-options.-A-completion-alias-can-be-specified-either-as-the-2nd-entry-in-the-options-table-or-te-alias-key.">list
The list completion group type displays in a list. A list item can either be a string, or a table for additional display options. The list completion group type displays in a list. A list item can either be a string, or a table for additional display options.
A completion alias can be specified either as the <code>2nd</code> entry in the options table A completion alias can be specified either as the <code class="text-violet-600 dark:text-violet-400">2nd</code> entry in the options table
or te <code>alias</code> key.</h3><p>A description can optionally be displayed for a list item, which is either the <code>1st</code> or te <code class="text-violet-600 dark:text-violet-400">alias</code> key.</h3><p>A description can optionally be displayed for a list item, which is either the <code class="text-violet-600 dark:text-violet-400">1st</code>
entry or the <code>description</code> key.</p><p>Lastly, list entries can be styled. This is done with the <code>display</code> key. If this is present, this entry or the <code class="text-violet-600 dark:text-violet-400">description</code> key.</p><p>Lastly, list entries can be styled. This is done with the <code class="text-violet-600 dark:text-violet-400">display</code> key. If this is present, this
overrides what the completion item <strong>looks</strong> like.</p><p>Example: overrides what the completion item <strong>looks</strong> like.</p><p>Example:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
{ {
items = { items = {
[&#39;--flag&#39;] = { [&#39;--flag&#39;] = {
@ -61,7 +61,7 @@ overrides what the completion item <strong>looks</strong> like.</p><p>Example:
}, },
type = &#39;list&#39; type = &#39;list&#39;
} }
</code></p><h1 class="font-bold text-4xl" id="Completion-Handler-Like-most-parts-of-Hilbish-it&#39;s-made-to-be-extensible-and-customizable.-The-default-handler-for-completions-in-general-can-be-overwritten-to-provide-more-advanced-completions-if-needed.-This-usually-doesn&#39;t-need-to-be-done-though-unless-you-know-what-you&#39;re-doing.">Completion Handler </code></p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Completion-Handler-Like-most-parts-of-Hilbish-it&#39;s-made-to-be-extensible-and-customizable.-The-default-handler-for-completions-in-general-can-be-overwritten-to-provide-more-advanced-completions-if-needed.-This-usually-doesn&#39;t-need-to-be-done-though-unless-you-know-what-you&#39;re-doing.">Completion Handler
Like most parts of Hilbish, it&#39;s made to be extensible and Like most parts of Hilbish, it&#39;s made to be extensible and
customizable. The default handler for completions in general can customizable. The default handler for completions in general can
be overwritten to provide more advanced completions if needed. be overwritten to provide more advanced completions if needed.
@ -69,11 +69,11 @@ This usually doesn&#39;t need to be done though, unless you know
what you&#39;re doing.</h1><p>The default completion handler provides 3 things: what you&#39;re doing.</h1><p>The default completion handler provides 3 things:
binaries (with a plain name requested to complete, those in binaries (with a plain name requested to complete, those in
$PATH), files, or command completions. It will try to run a handler $PATH), files, or command completions. It will try to run a handler
for the command or fallback to file completions.</p><p>To overwrite it, just assign a function to <code>hilbish.completion.handler</code> like so: for the command or fallback to file completions.</p><p>To overwrite it, just assign a function to <code class="text-violet-600 dark:text-violet-400">hilbish.completion.handler</code> like so:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
-- line is the entire line as a string -- line is the entire line as a string
-- pos is the position of the cursor. -- pos is the position of the cursor.
function hilbish.completion.handler(line, pos) function hilbish.completion.handler(line, pos)
-- do things -- do things
end end
</code></p></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> </code></p></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="http://localhost:9080"><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>

10
versions/new-website/docs/faq/index.html
View File

@ -1,14 +1,14 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Frequently Asked Questions</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Frequently Asked Questions</h1><h1 class="font-bold text-4xl" id="Is-Hilbish-POSIX-compliant-No-it-is-not.-POSIX-compliance-is-a-non-goal.-Perhaps-in-the-future-someone-would-be-able-to-write-a-native-plugin-to-support-shell-scripting-(which-would-be-against-it&#39;s-main-goal-but-....)">Is Hilbish POSIX compliant? <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Frequently Asked Questions</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Frequently Asked Questions</h1><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Is-Hilbish-POSIX-compliant-No-it-is-not.-POSIX-compliance-is-a-non-goal.-Perhaps-in-the-future-someone-would-be-able-to-write-a-native-plugin-to-support-shell-scripting-(which-would-be-against-it&#39;s-main-goal-but-....)">Is Hilbish POSIX compliant?
No, it is not. POSIX compliance is a non-goal. Perhaps in the future, No, it is not. POSIX compliance is a non-goal. Perhaps in the future,
someone would be able to write a native plugin to support shell scripting someone would be able to write a native plugin to support shell scripting
(which would be against it&#39;s main goal, but ....)</h1><h1 class="font-bold text-4xl" id="Windows-Support-It-compiles-for-Windows-(CI-ensures-it-does)-but-otherwise-it-is-not-directly-supported.-If-you&#39;d-like-to-improve-this-situation-checkout-the-discussion.">Windows Support? (which would be against it&#39;s main goal, but ....)</h1><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Windows-Support-It-compiles-for-Windows-(CI-ensures-it-does)-but-otherwise-it-is-not-directly-supported.-If-you&#39;d-like-to-improve-this-situation-checkout-the-discussion.">Windows Support?
It compiles for Windows (CI ensures it does), but otherwise it is not It compiles for Windows (CI ensures it does), but otherwise it is not
directly supported. If you&#39;d like to improve this situation, directly supported. If you&#39;d like to improve this situation,
checkout <a href="https://github.com/Rosettea/Hilbish/discussions/165">the discussion</a>.</h1><h1 class="font-bold text-4xl" id="Why-Hilbish-emerged-from-the-desire-of-a-Lua-configured-shell.-It-was-the-initial-reason-that-it-was-created-but-now-it&#39;s-more:-to-be-hyper-extensible-simpler-and-more-user-friendly.">Why? checkout <a href="https://github.com/Rosettea/Hilbish/discussions/165">the discussion</a>.</h1><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Why-Hilbish-emerged-from-the-desire-of-a-Lua-configured-shell.-It-was-the-initial-reason-that-it-was-created-but-now-it&#39;s-more:-to-be-hyper-extensible-simpler-and-more-user-friendly.">Why?
Hilbish emerged from the desire of a Lua configured shell. Hilbish emerged from the desire of a Lua configured shell.
It was the initial reason that it was created, but now it&#39;s more: It was the initial reason that it was created, but now it&#39;s more:
to be hyper extensible, simpler and more user friendly.</h1><h1 class="font-bold text-4xl" id="Does-it-have-&quot;autocompletion&quot;-or-&quot;tab-completion&quot;-Of-course-This-is-a-modern-shell.-Hilbish-provides-a-way-for-users-to-write-tab-completion-for-any-command-and/or-the-whole-shell.-Inline-hinting-and-syntax-highlighting-are-also-available.">Does it have &quot;autocompletion&quot; or &quot;tab completion&quot; to be hyper extensible, simpler and more user friendly.</h1><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Does-it-have-&quot;autocompletion&quot;-or-&quot;tab-completion&quot;-Of-course-This-is-a-modern-shell.-Hilbish-provides-a-way-for-users-to-write-tab-completion-for-any-command-and/or-the-whole-shell.-Inline-hinting-and-syntax-highlighting-are-also-available.">Does it have &quot;autocompletion&quot; or &quot;tab completion&quot;
Of course! This is a modern shell. Hilbish provides a way for users Of course! This is a modern shell. Hilbish provides a way for users
to write tab completion for any command and/or the whole shell. to write tab completion for any command and/or the whole shell.
Inline hinting and syntax highlighting are also available.</h1></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> Inline hinting and syntax highlighting are also available.</h1></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="http://localhost:9080"><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>

5
versions/new-website/docs/fe/index.html Normal file
View File

@ -0,0 +1,5 @@
<!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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Features</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Features</h1><p>Hilbish has a wide range of features to enhance the user&#39;s experience
new ones are always being added. If there is something missing here or
something you would like to see, please <a href="https://github.com/Rosettea/Hilbish/discussions">start a discussion</a>
or comment on any existing ones which match your request.</p></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="http://localhost:9080"><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>

5
versions/new-website/docs/features/index.html
View File

@ -1,5 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Features</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Features</h1><p>Hilbish has a wide range of features to enhance the user&#39;s experience
new ones are always being added. If there is something missing here or
something you would like to see, please <a href="https://github.com/Rosettea/Hilbish/discussions">start a discussion</a>
or comment on any existing ones which match your request.</p></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>

30
versions/new-website/docs/features/notifications/index.html
View File

@ -1,23 +1,23 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Notification</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Notification</h1><p>Hilbish features a simple notification system which can be <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Notification</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Notification</h1><p>Hilbish features a simple notification system which can be
used by other plugins and parts of the shell to notify the user used by other plugins and parts of the shell to notify the user
of various actions. This is used via the <code>hilbish.message</code> interface.</p><p>A <code>message</code> is defined as a table with the following properties: of various actions. This is used via the <code class="text-violet-600 dark:text-violet-400">hilbish.message</code> interface.</p><p>A <code class="text-violet-600 dark:text-violet-400">message</code> is defined as a table with the following properties:
- <code>icon</code>: A unicode/emoji icon for the notification. - <code class="text-violet-600 dark:text-violet-400">icon</code>: A unicode/emoji icon for the notification.
- <code>title</code>: The title of the message - <code class="text-violet-600 dark:text-violet-400">title</code>: The title of the message
- <code>text</code>: Message text/body - <code class="text-violet-600 dark:text-violet-400">text</code>: Message text/body
- <code>channel</code>: The source of the message. This should be a - <code class="text-violet-600 dark:text-violet-400">channel</code>: The source of the message. This should be a
unique and easily readable text identifier. unique and easily readable text identifier.
- <code>summary</code>: A short summary of the notification and message. - <code class="text-violet-600 dark:text-violet-400">summary</code>: A short summary of the notification and message.
If this is not present and you are using this to display messages, If this is not present and you are using this to display messages,
you should take part of the <code>text</code> instead.</p><p>The <code>hilbish.message</code> interface provides the following functions: you should take part of the <code class="text-violet-600 dark:text-violet-400">text</code> instead.</p><p>The <code class="text-violet-600 dark:text-violet-400">hilbish.message</code> interface provides the following functions:
- <code>send(message)</code>: Sends a message and emits the <code>hilbish.notification</code> - <code class="text-violet-600 dark:text-violet-400">send(message)</code>: Sends a message and emits the <code class="text-violet-600 dark:text-violet-400">hilbish.notification</code>
signal. DO NOT emit the <code>hilbish.notification</code> signal directly, or signal. DO NOT emit the <code class="text-violet-600 dark:text-violet-400">hilbish.notification</code> signal directly, or
the message will not be stored by the message handler. the message will not be stored by the message handler.
- <code>read(idx)</code>: Marks message at <code>idx</code> as read. - <code class="text-violet-600 dark:text-violet-400">read(idx)</code>: Marks message at <code class="text-violet-600 dark:text-violet-400">idx</code> as read.
- <code>delete(idx)</code>: Removes message at <code>idx</code>. - <code class="text-violet-600 dark:text-violet-400">delete(idx)</code>: Removes message at <code class="text-violet-600 dark:text-violet-400">idx</code>.
- <code>readAll()</code>: Marks all messages as read. - <code class="text-violet-600 dark:text-violet-400">readAll()</code>: Marks all messages as read.
- <code>clear()</code>: Deletes all messages.</p><p>There are a few simple use cases of this notification/messaging system. - <code class="text-violet-600 dark:text-violet-400">clear()</code>: Deletes all messages.</p><p>There are a few simple use cases of this notification/messaging system.
It could also be used as some &quot;inter-shell&quot; messaging system (???) but It could also be used as some &quot;inter-shell&quot; messaging system (???) but
is intended to display to users.</p><p>An example is notifying users of completed jobs/commands ran in the background. is intended to display to users.</p><p>An example is notifying users of completed jobs/commands ran in the background.
Any Hilbish-native command (think the upcoming Greenhouse pager) can display Any Hilbish-native command (think the upcoming Greenhouse pager) can display
it.</p></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> it.</p></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="http://localhost:9080"><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>

36
versions/new-website/docs/features/opts/index.html
View File

@ -1,11 +1,11 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Options</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Options</h1><p>Opts are simple toggle or value options a user can set in Hilbish. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Options</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Options</h1><p>Opts are simple toggle or value options a user can set in Hilbish.
As toggles, there are things like <code>autocd</code> or history saving. As values, As toggles, there are things like <code class="text-violet-600 dark:text-violet-400">autocd</code> or history saving. As values,
there is the <code>motd</code> which the user can either change to a custom string or disable.</p><p>Opts are accessed from the <code>hilbish.opts</code> table. Here they can either there is the <code class="text-violet-600 dark:text-violet-400">motd</code> which the user can either change to a custom string or disable.</p><p>Opts are accessed from the <code class="text-violet-600 dark:text-violet-400">hilbish.opts</code> table. Here they can either
be read or modified</p><h3 class="font-bold text-2xl" id="autocd"><code>autocd</code></h3><p class="font-bold text-xl" id="Value:-boolean-Default:-false">Value: <code>boolean</code> be read or modified</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="autocd"><code class="text-violet-600 dark:text-violet-400">autocd</code></h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean-Default:-false">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code>
Default: <code>false</code></p><p>The autocd opt makes it so that lone directories attempted to be executed are Default: <code class="text-violet-600 dark:text-violet-400">false</code></p><p>The autocd opt makes it so that lone directories attempted to be executed are
instead set as the shell&#39;s directory.</p><p>Example: instead set as the shell&#39;s directory.</p><p>Example:
<code> <code class="text-violet-600 dark:text-violet-400">
~/Directory ~/Directory
∆ ~ ∆ ~
~ ~
@ -14,22 +14,24 @@ instead set as the shell&#39;s directory.</p><p>Example:
∆ ../Documents ∆ ../Documents
~/Documents ~/Documents
∆ ∆
</code></p><p>&lt;hr&gt;</p><h3 class="font-bold text-2xl" id="history"><code>history</code></h3><p class="font-bold text-xl" id="Value:-boolean-Default:-true-Sets-whether-command-history-will-be-saved-or-not.">Value: <code>boolean</code> </code></p><p>&lt;hr&gt;</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="history"><code class="text-violet-600 dark:text-violet-400">history</code></h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean-Default:-true-Sets-whether-command-history-will-be-saved-or-not.">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code>
Default: <code>true</code> Default: <code class="text-violet-600 dark:text-violet-400">true</code>
Sets whether command history will be saved or not.</p><p>&lt;hr&gt; Sets whether command history will be saved or not.</p><p>&lt;hr&gt;
### <code>greeting</code> ### <code class="text-violet-600 dark:text-violet-400">greeting</code>
#### Value: <code>boolean</code> or <code>string</code> #### Value: <code class="text-violet-600 dark:text-violet-400">boolean</code> or <code class="text-violet-600 dark:text-violet-400">string</code>
The greeting is the message that Hilbish shows on startup The greeting is the message that Hilbish shows on startup
(the one which says Welcome to Hilbish).</p><p>This can be set to either true/false to enable/disable or a custom greeting string.</p><p>&lt;hr&gt;</p><h3 class="font-bold text-2xl" id="motd"><code>motd</code></h3><p class="font-bold text-xl" id="Value:-boolean-Default:-true-The-message-of-the-day-shows-the-current-major.minor-version-and-includes-a-small-range-of-things-added-in-the-current-release.">Value: <code>boolean</code> (the one which says Welcome to Hilbish).</p><p>This can be set to either true/false to enable/disable or a custom greeting string.</p><p>&lt;hr&gt;</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="motd"><code class="text-violet-600 dark:text-violet-400">motd</code></h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean-Default:-true-The-message-of-the-day-shows-the-current-major.minor-version-and-includes-a-small-range-of-things-added-in-the-current-release.">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code>
Default: <code>true</code> Default: <code class="text-violet-600 dark:text-violet-400">true</code>
The message of the day shows the current major.minor version and The message of the day shows the current major.minor version and
includes a small range of things added in the current release.</p><p>This can be set to <code>false</code> to disable the message.</p><p>&lt;hr&gt;</p><h3 class="font-bold text-2xl" id="fuzzy"><code>fuzzy</code></h3><p class="font-bold text-xl" id="Value:-boolean-Default:-false-Toggles-the-functionality-of-fuzzy-history-searching-usable-via-the-menu-in-Ctrl-R.-Fuzzy-searching-is-an-approximate-searching-method-which-means-results-that-match-closest-will-be-shown-instead-of-an-exact-match.">Value: <code>boolean</code> includes a small range of things added in the current release.</p><p>This can be set to <code class="text-violet-600 dark:text-violet-400">false</code> to disable the message.</p><p>&lt;hr&gt;</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="fuzzy"><code class="text-violet-600 dark:text-violet-400">fuzzy</code></h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean-Default:-false-Toggles-the-functionality-of-fuzzy-history-searching-usable-via-the-menu-in-Ctrl-R.-Fuzzy-searching-is-an-approximate-searching-method-which-means-results-that-match-closest-will-be-shown-instead-of-an-exact-match.">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code>
Default: <code>false</code> Default: <code class="text-violet-600 dark:text-violet-400">false</code>
Toggles the functionality of fuzzy history searching, usable Toggles the functionality of fuzzy history searching, usable
via the menu in Ctrl-R. Fuzzy searching is an approximate searching via the menu in Ctrl-R. Fuzzy searching is an approximate searching
method, which means results that match <strong>closest</strong> will be shown instead method, which means results that match <strong>closest</strong> will be shown instead
of an exact match.</p><p>&lt;hr&gt;</p><h3 class="font-bold text-2xl" id="notifyJobFinish"><code>notifyJobFinish</code></h3><p class="font-bold text-xl" id="Value:-boolean-Default:-true-If-this-is-enabled-when-a-background-job-is-finished-a-notification-will-be-sent.">Value: <code>boolean</code> of an exact match.</p><p>&lt;hr&gt;</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="notifyJobFinish"><code class="text-violet-600 dark:text-violet-400">notifyJobFinish</code></h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean-Default:-true-If-this-is-enabled-when-a-background-job-is-finished-a-notification-will-be-sent.">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code>
Default: <code>true</code> Default: <code class="text-violet-600 dark:text-violet-400">true</code>
If this is enabled, when a background job is finished, If this is enabled, when a background job is finished,
a <a href="../notifications">notification</a> will be sent.</p></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> a <a href="../notifications">notification</a> will be sent.</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="processorSkipList"><code class="text-violet-600 dark:text-violet-400">processorSkipList</code></h3><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-table-Default:-{}-A-table-listing-the-names-of-command-processors-to-skip.">Value: <code class="text-violet-600 dark:text-violet-400">table</code>
Default: <code class="text-violet-600 dark:text-violet-400">{}</code>
A table listing the names of command processors to skip.</p></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="http://localhost:9080"><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>

30
versions/new-website/docs/features/runner-mode/index.html
View File

@ -1,29 +1,29 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Runner Mode</h1><p>Hilbish allows you to change how interactive text can be interpreted. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Runner Mode</h1><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 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 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 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 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 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">Link.hsh</a> evaluating like normal, which is how <a href="https://github.com/TorchedSammy/Link.hsh">Link.hsh</a>
handles links.</p><p>The &quot;runner mode&quot; of Hilbish is customizable via <code>hilbish.runnerMode</code>, handles links.</p><p>The &quot;runner mode&quot; 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 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 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 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> 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.</p><p>You can also set it to a function, which will be called everytime Hilbish 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">API documentation</a></p><p>The <code>hilbish.runner</code> interface is an alternative to using <code>hilbish.runnerMode</code> needs to run interactive input. For more detail, see the <a href="../../api/hilbish/hilbish.runner">API documentation</a></p><p>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="font-bold text-3xl" id="Functions-These-are-the-&quot;low-level&quot;-functions-for-the-hilbish.runner-interface.">Functions and also provides the shell script and Lua runner functions that Hilbish itself uses.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions-These-are-the-&quot;low-level&quot;-functions-for-the-hilbish.runner-interface.">Functions
These are the &quot;low level&quot; functions for the <code>hilbish.runner</code> interface.</h2><p>+ setMode(mode) &gt; The same as <code>hilbish.runnerMode</code> These are the &quot;low level&quot; functions for the <code class="text-violet-600 dark:text-violet-400">hilbish.runner</code> interface.</h2><p>+ setMode(mode) &gt; The same as <code class="text-violet-600 dark:text-violet-400">hilbish.runnerMode</code>
+ sh(input) -&gt; table &gt; Runs <code>input</code> in Hilbish&#39;s sh interpreter + sh(input) -&gt; table &gt; Runs <code class="text-violet-600 dark:text-violet-400">input</code> in Hilbish&#39;s sh interpreter
+ lua(input) -&gt; table &gt; Evals <code>input</code> as Lua code</p><p>These functions should be preferred over the previous ones. + lua(input) -&gt; table &gt; Evals <code class="text-violet-600 dark:text-violet-400">input</code> as Lua code</p><p>These functions should be preferred over the previous ones.
+ setCurrent(mode) &gt; The same as <code>setMode</code>, but works with runners managed + setCurrent(mode) &gt; The same as <code class="text-violet-600 dark:text-violet-400">setMode</code>, but works with runners managed
via the functions below. via the functions below.
+ add(name, runner) &gt; Adds a runner to a table of available runners. The <code>runner</code> + add(name, runner) &gt; 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. argument is either a function or a table with a run callback.
+ set(name, runner) &gt; The same as <code>add</code> but requires passing a table and + set(name, runner) &gt; The same as <code class="text-violet-600 dark:text-violet-400">add</code> but requires passing a table and
overwrites if the <code>name</code>d runner already exists. overwrites if the <code class="text-violet-600 dark:text-violet-400">name</code>d runner already exists.
+ get(name) &gt; runner &gt; Gets a runner by name. It is a table with at least a + get(name) &gt; runner &gt; Gets a runner by name. It is a table with at least a
run function, to run input. run function, to run input.
+ exec(cmd, runnerName) &gt; Runs <code>cmd</code> with a runner. If <code>runnerName</code> isn&#39;t passed, + exec(cmd, runnerName) &gt; 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&#39;t passed,
the current runner mode is used.</p></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> the current runner mode is used.</p></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="http://localhost:9080"><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>

46
versions/new-website/docs/getting-started/index.html
View File

@ -1,28 +1,28 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Getting Started</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Getting Started</h1><p>To start Hilbish, open a terminal. If Hilbish has been installed and is not the <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Getting Started</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Getting Started</h1><p>To start Hilbish, open a terminal. If Hilbish has been installed and is not the
default shell, you can simply run <code>hilbish</code> to start it. This will launch default shell, you can simply run <code class="text-violet-600 dark:text-violet-400">hilbish</code> to start it. This will launch
a normal interactive session. a normal interactive session.
To exit, you can either run the <code>exit</code> command or hit Ctrl+D.</p><h1 class="font-bold text-4xl" id="Setting-as-Default">Setting as Default</h1><h2 class="font-bold text-3xl" id="Login-shell-There-are-a-few-ways-to-make-Hilbish-your-default-shell.-A-simple-way-is--to-make-it-your-user/login-shell.">Login shell To exit, you can either run the <code class="text-violet-600 dark:text-violet-400">exit</code> command or hit Ctrl+D.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Setting-as-Default">Setting as Default</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Login-shell-There-are-a-few-ways-to-make-Hilbish-your-default-shell.-A-simple-way-is--to-make-it-your-user/login-shell.">Login shell
There are a few ways to make Hilbish your default shell. A simple way is There are a few ways to make Hilbish your default shell. A simple way is
to make it your user/login shell.</h2><p>{{&lt; warning <code>It is not recommended to set Hilbish as your login shell. That to make it your user/login shell.</h2><p>{{&lt; warning <code class="text-violet-600 dark:text-violet-400">It is not recommended to set Hilbish as your login shell. That
is expected to be a POSIX compliant shell, which Hilbish is not. Though if is expected to be a POSIX compliant shell, which Hilbish is not. Though if
you still decide to do it, there will just be a few variables missing in you still decide to do it, there will just be a few variables missing in
your environment</code> &gt;}}</p><p>To do that, simply run <code>chsh -s /usr/bin/hilbish</code>. your environment</code> &gt;}}</p><p>To do that, simply run <code class="text-violet-600 dark:text-violet-400">chsh -s /usr/bin/hilbish</code>.
Some distros (namely Fedora) might have <code>lchsh</code> instead, which is used like <code>lchsh &lt;user&gt;</code>. Some distros (namely Fedora) might have <code class="text-violet-600 dark:text-violet-400">lchsh</code> instead, which is used like <code class="text-violet-600 dark:text-violet-400">lchsh &lt;user&gt;</code>.
When prompted, you can put the path for Hilbish.</p><h2 class="font-bold text-3xl" id="Default-with-terminal-The-simpler-way-is-to-set-the-default-shell-for-your-terminal.-The-way-of--doing-this-depends-on-how-your-terminal-settings-are-configured.">Default with terminal When prompted, you can put the path for Hilbish.</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Default-with-terminal-The-simpler-way-is-to-set-the-default-shell-for-your-terminal.-The-way-of--doing-this-depends-on-how-your-terminal-settings-are-configured.">Default with terminal
The simpler way is to set the default shell for your terminal. The way of The simpler way is to set the default shell for your terminal. The way of
doing this depends on how your terminal settings are configured.</h2><h2 class="font-bold text-3xl" id="Run-after-login-shell-Some-shells-(like-zsh)-have-an-rc-file-like-.zlogin-which-is-ran-when-the-shell-session-is-a-login-shell.-In-that-file-you-can-run-Hilbish.-Example:">Run after login shell doing this depends on how your terminal settings are configured.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Run-after-login-shell-Some-shells-(like-zsh)-have-an-rc-file-like-.zlogin-which-is-ran-when-the-shell-session-is-a-login-shell.-In-that-file-you-can-run-Hilbish.-Example:">Run after login shell
Some shells (like zsh) have an rc file, like <code>.zlogin</code>, which is ran when the shell session Some shells (like zsh) have an rc file, like <code class="text-violet-600 dark:text-violet-400">.zlogin</code>, which is ran when the shell session
is a login shell. In that file, you can run Hilbish. Example:</h2><pre><code data-lang="text">exec hilbish -S -l is a login shell. In that file, you can run Hilbish. Example:</h2><pre><code data-lang="text">exec hilbish -S -l
</code></pre><p>This will replace the shell with Hilbish, set $SHELL to Hilbish and launch it as a login shell.</p><h1 class="font-bold text-4xl" id="Configuration-Once-installation-and-setup-has-been-done-you-can-then-configure-Hilbish.-It-is-configured-and-scripted-via-Lua-so-the-config-file-is-a-Lua-file.-You-can-use-any-pure-Lua-library-to-do-whatever-you-want.">Configuration </code></pre><p>This will replace the shell with Hilbish, set $SHELL to Hilbish and launch it as a login shell.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Configuration-Once-installation-and-setup-has-been-done-you-can-then-configure-Hilbish.-It-is-configured-and-scripted-via-Lua-so-the-config-file-is-a-Lua-file.-You-can-use-any-pure-Lua-library-to-do-whatever-you-want.">Configuration
Once installation and setup has been done, you can then configure Hilbish. Once installation and setup has been done, you can then configure Hilbish.
It is configured and scripted via Lua, so the config file is a Lua file. It is configured and scripted via Lua, so the config file is a Lua file.
You can use any pure Lua library to do whatever you want.</h1><p>Hilbish&#39;s sample configuration is usually located in <code>hilbish.dataDir .. &#39;/.hilbishrc.lua&#39;</code>. You can use any pure Lua library to do whatever you want.</h1><p>Hilbish&#39;s sample configuration is usually located in <code class="text-violet-600 dark:text-violet-400">hilbish.dataDir .. &#39;/.hilbishrc.lua&#39;</code>.
You can print that path via Lua to see what it is: <code>print(hilbish.dataDir .. &#39;/.hilbishrc.lua&#39;)</code>. You can print that path via Lua to see what it is: <code class="text-violet-600 dark:text-violet-400">print(hilbish.dataDir .. &#39;/.hilbishrc.lua&#39;)</code>.
As an example, it will usually will result in <code>/usr/share/hilbish/.hilbishrc.lua</code> on Linux.</p><p>To edit your user configuration, you can copy that file to <code>hilbish.userDir.config .. &#39;/hilbish/init.lua&#39;</code>, As an example, it will usually will result in <code class="text-violet-600 dark:text-violet-400">/usr/share/hilbish/.hilbishrc.lua</code> on Linux.</p><p>To edit your user configuration, you can copy that file to <code class="text-violet-600 dark:text-violet-400">hilbish.userDir.config .. &#39;/hilbish/init.lua&#39;</code>,
which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p><p>As the directory is usually <code>~/.config</code> on Linux, you can run this command to copy it: which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p><p>As the directory is usually <code class="text-violet-600 dark:text-violet-400">~/.config</code> on Linux, you can run this command to copy it:
<code>cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code></p><p>Now we can get to customization!</p><p>If we closely examine a small snippet of the default config: <code class="text-violet-600 dark:text-violet-400">cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code></p><p>Now we can get to customization!</p><p>If we closely examine a small snippet of the default config:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
-- Default Hilbish config -- Default Hilbish config
-- .. with some omitted code .. --</code></p><p>local function doPrompt(fail) -- .. with some omitted code .. --</code></p><p>local function doPrompt(fail)
hilbish.prompt(lunacolors.format( hilbish.prompt(lunacolors.format(
@ -31,11 +31,11 @@ which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p
end</p><p>doPrompt()</p><p>bait.catch(&#39;command.exit&#39;, function(code) end</p><p>doPrompt()</p><p>bait.catch(&#39;command.exit&#39;, function(code)
doPrompt(code ~= 0) doPrompt(code ~= 0)
end) end)
<code></code></p><p>We see a whopping *<strong>three</strong>* Hilbish libraries being used in this part of code. <code class="text-violet-600 dark:text-violet-400"></code></p><p>We see a whopping *<strong>three</strong>* Hilbish libraries being used in this part of code.
First is of course, named after the shell itself, <a href="../api/hilbish"><code>hilbish</code></a>. This is kind of a First is of course, named after the shell itself, <a href="../api/hilbish"><code class="text-violet-600 dark:text-violet-400">hilbish</code></a>. This is kind of a
&quot;catch-all&quot; namespace for functions that directly related to shell functionality/settings.</p><p>And as we can see, the <a href="../api/hilbish/#prompt">hilbish.prompt</a> function is used &quot;catch-all&quot; namespace for functions that directly related to shell functionality/settings.</p><p>And as we can see, the <a href="../api/hilbish/#prompt">hilbish.prompt</a> function is used
to change our prompt. Change our prompt to what, exactly?</p><p>The doc for the function states that the verbs <code>%u</code> and <code>%d</code>are used for username and current directory to change our prompt. Change our prompt to what, exactly?</p><p>The doc for the function states that the verbs <code class="text-violet-600 dark:text-violet-400">%u</code> and <code class="text-violet-600 dark:text-violet-400">%d</code>are used for username and current directory
of the shell, respectively. </p><p>We wrap this in the <a href="../lunacolors"><code>lunacolors.format</code></a> function, to give of the shell, respectively. </p><p>We wrap this in the <a href="../lunacolors"><code class="text-violet-600 dark:text-violet-400">lunacolors.format</code></a> function, to give
our prompt some nice color.</p><p>But you might have also noticed that this is in the <code>doPrompt</code> function, which is called once, our prompt some nice color.</p><p>But you might have also noticed that this is in the <code class="text-violet-600 dark:text-violet-400">doPrompt</code> function, which is called once,
and then used again in a <a href="../api/bait">bait</a> hook. Specifically, the <code>command.exit</code> hook, and then used again in a <a href="../api/bait">bait</a> hook. Specifically, the <code class="text-violet-600 dark:text-violet-400">command.exit</code> hook,
which is called after a command exits, so when it finishes running.</p></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> which is called after a command exits, so when it finishes running.</p></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="http://localhost:9080"><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>

28
versions/new-website/docs/hooks/command/index.html
View File

@ -1,21 +1,21 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Command</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Command</h1><h2 class="font-bold text-3xl" id="command.preexec-Thrown-right-before-a-command-is-executed.">command.preexec <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Command</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Command</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="command.preexec-Thrown-right-before-a-command-is-executed.">command.preexec
Thrown right before a command is executed.</h2><p class="font-bold text-xl" id="Variables-string-**input**---The-raw-string-that-the-user-typed.-This-will-include-the-text-without-changes-applied-to-it-(argument-substitution-alias-expansion-etc.)">Variables Thrown right before a command is executed.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-string-**input**---The-raw-string-that-the-user-typed.-This-will-include-the-text-without-changes-applied-to-it-(argument-substitution-alias-expansion-etc.)">Variables
<code>string</code> **<code>input</code>** <code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">input</code>**
The raw string that the user typed. This will include the text The raw string that the user typed. This will include the text
without changes applied to it (argument substitution, alias expansion, without changes applied to it (argument substitution, alias expansion,
etc.)</p><p><code>string</code> **<code>cmdStr</code>** etc.)</p><p><code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">cmdStr</code>**
The command that will be directly executed by the current runner.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="command.exit-Thrown-after-the-user&#39;s-ran-command-is-finished.">command.exit The command that will be directly executed by the current runner.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="command.exit-Thrown-after-the-user&#39;s-ran-command-is-finished.">command.exit
Thrown after the user&#39;s ran command is finished.</h2><p class="font-bold text-xl" id="Variables-number-**code**---The-exit-code-of-what-was-executed.">Variables Thrown after the user&#39;s ran command is finished.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-number-**code**---The-exit-code-of-what-was-executed.">Variables
<code>number</code> **<code>code</code>** <code class="text-violet-600 dark:text-violet-400">number</code> **<code class="text-violet-600 dark:text-violet-400">code</code>**
The exit code of what was executed.</p><p><code>string</code> **<code>cmdStr</code>** The exit code of what was executed.</p><p><code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">cmdStr</code>**
The command or code that was executed</p><p>&lt;hr&gt; The command or code that was executed</p><p>&lt;hr&gt;
## command.not-found ## command.not-found
Thrown if the command attempted to execute was not found. Thrown if the command attempted to execute was not found.
This can be used to customize the text printed when a command is not found. This can be used to customize the text printed when a command is not found.
Example: Example:
<code>lua <code class="text-violet-600 dark:text-violet-400">lua
local bait = require &#39;bait&#39; local bait = require &#39;bait&#39;
-- Remove any present handlers on `command.not-found</code></p><p>local notFoundHooks = bait.hooks &#39;command.not-found&#39; -- Remove any present handlers on `command.not-found</code></p><p>local notFoundHooks = bait.hooks &#39;command.not-found&#39;
for _, hook in ipairs(notFoundHooks) do for _, hook in ipairs(notFoundHooks) do
@ -24,12 +24,12 @@ end</p><p>-- then assign custom
bait.catch(&#39;command.not-found&#39;, function(cmd) bait.catch(&#39;command.not-found&#39;, function(cmd)
print(string.format(&#39;The command &quot;%s&quot; was not found.&#39;, cmd)) print(string.format(&#39;The command &quot;%s&quot; was not found.&#39;, cmd))
end) end)
<code></code></p><p class="font-bold text-xl" id="Variables-string-**cmdStr**---The-name-of-the-command.">Variables <code class="text-violet-600 dark:text-violet-400"></code></p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-string-**cmdStr**---The-name-of-the-command.">Variables
<code>string</code> **<code>cmdStr</code>** <code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">cmdStr</code>**
The name of the command.</p><p>&lt;hr&gt; The name of the command.</p><p>&lt;hr&gt;
## command.not-executable ## command.not-executable
Thrown when the user attempts to run a file that is not executable Thrown when the user attempts to run a file that is not executable
(like a text file, or Unix binary without +x permission).</p><p class="font-bold text-xl">Variables (like a text file, or Unix binary without +x permission).</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Variables
<code>string</code> **<code>cmdStr</code>** <code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">cmdStr</code>**
The name of the command.</p></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> The name of the command.</p></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="http://localhost:9080"><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>

38
versions/new-website/docs/hooks/hilbish/index.html
View File

@ -1,25 +1,25 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Hilbish</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Hilbish</h1><h2 class="font-bold text-3xl" id="hilbish.exit-Sent-when-Hilbish-is-going-to-exit.">hilbish.exit <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Hilbish</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Hilbish</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="hilbish.exit-Sent-when-Hilbish-is-going-to-exit.">hilbish.exit
Sent when Hilbish is going to exit.</h2><p class="font-bold text-xl" id="Variables-This-signal-returns-no-variables.">Variables Sent when Hilbish is going to exit.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-This-signal-returns-no-variables.">Variables
This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="hilbish.vimMode-Sent-when-the-Vim-mode-of-Hilbish-is-changed-(like-from-insert-to-normal-mode).-This-can-be-used-to-change-the-prompt-and-notify-based-on-Vim-mode.">hilbish.vimMode This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="hilbish.vimMode-Sent-when-the-Vim-mode-of-Hilbish-is-changed-(like-from-insert-to-normal-mode).-This-can-be-used-to-change-the-prompt-and-notify-based-on-Vim-mode.">hilbish.vimMode
Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). Sent when the Vim mode of Hilbish is changed (like from insert to normal mode).
This can be used to change the prompt and notify based on Vim mode.</h2><p class="font-bold text-xl" id="Variables-string-**modeName**---The-mode-that-has-been-set.-Can-be-these-values:-insert-normal-delete-or-replace">Variables This can be used to change the prompt and notify based on Vim mode.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-string-**modeName**---The-mode-that-has-been-set.-Can-be-these-values:-insert-normal-delete-or-replace">Variables
<code>string</code> **<code>modeName</code>** <code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">modeName</code>**
The mode that has been set. The mode that has been set.
Can be these values: <code>insert</code>, <code>normal</code>, <code>delete</code> or <code>replace</code></p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="hilbish.cancel-Sent-when-the-user-cancels-their-command-input-with-Ctrl-C">hilbish.cancel Can be these values: <code class="text-violet-600 dark:text-violet-400">insert</code>, <code class="text-violet-600 dark:text-violet-400">normal</code>, <code class="text-violet-600 dark:text-violet-400">delete</code> or <code class="text-violet-600 dark:text-violet-400">replace</code></p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="hilbish.cancel-Sent-when-the-user-cancels-their-command-input-with-Ctrl-C">hilbish.cancel
Sent when the user cancels their command input with Ctrl-C</h2><p class="font-bold text-xl">Variables Sent when the user cancels their command input with Ctrl-C</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Variables
This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="hilbish.notification-Thrown-when-a-notification-is-sent.">hilbish.notification This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="hilbish.notification-Thrown-when-a-notification-is-sent.">hilbish.notification
Thrown when a <a href="../../features/notifications">notification</a> is sent.</h2><p class="font-bold text-xl" id="Variables-table-**notification**---The-notification.-The-properties-are-defined-in-the-link-above.">Variables Thrown when a <a href="../../features/notifications">notification</a> is sent.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-table-**notification**---The-notification.-The-properties-are-defined-in-the-link-above.">Variables
<code>table</code> **<code>notification</code>** <code class="text-violet-600 dark:text-violet-400">table</code> **<code class="text-violet-600 dark:text-violet-400">notification</code>**
The notification. The properties are defined in the link above.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="hilbish.cd-Sent-when-the-current-directory-of-the-shell-is-changed-(via-interactive-means.)-If-you-are-implementing-a-custom-command-that-changes-the-directory-of-the-shell-you-must-throw-this-hook-manually-for-correctness.">hilbish.cd The notification. The properties are defined in the link above.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="hilbish.cd-Sent-when-the-current-directory-of-the-shell-is-changed-(via-interactive-means.)-If-you-are-implementing-a-custom-command-that-changes-the-directory-of-the-shell-you-must-throw-this-hook-manually-for-correctness.">hilbish.cd
Sent when the current directory of the shell is changed (via interactive means.) Sent when the current directory of the shell is changed (via interactive means.)
If you are implementing a custom command that changes the directory of the shell, If you are implementing a custom command that changes the directory of the shell,
you must throw this hook manually for correctness.</h2><p class="font-bold text-xl" id="Variables-string-**path**---Absolute-path-of-the-directory-that-was-changed-to.">Variables you must throw this hook manually for correctness.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-string-**path**---Absolute-path-of-the-directory-that-was-changed-to.">Variables
<code>string</code> **<code>path</code>** <code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">path</code>**
Absolute path of the directory that was changed to.</p><p><code>string</code> **<code>oldPath</code>** Absolute path of the directory that was changed to.</p><p><code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">oldPath</code>**
Absolute path of the directory Hilbish <strong>was</strong> in.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="hilbish.vimAction-Sent-when-the-user-does-a-&quot;vim-action&quot;-being-something-like-yanking-or-pasting-text.-See-doc-vim-mode-actions-for-more-info.">hilbish.vimAction Absolute path of the directory Hilbish <strong>was</strong> in.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="hilbish.vimAction-Sent-when-the-user-does-a-&quot;vim-action&quot;-being-something-like-yanking-or-pasting-text.-See-doc-vim-mode-actions-for-more-info.">hilbish.vimAction
Sent when the user does a &quot;vim action,&quot; being something like yanking or pasting text. Sent when the user does a &quot;vim action,&quot; being something like yanking or pasting text.
See <code>doc vim-mode actions</code> for more info.</h2><p class="font-bold text-xl" id="Variables-string-**actionName**---Absolute-path-of-the-directory-that-was-changed-to.">Variables See <code class="text-violet-600 dark:text-violet-400">doc vim-mode actions</code> for more info.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-string-**actionName**---Absolute-path-of-the-directory-that-was-changed-to.">Variables
<code>string</code> **<code>actionName</code>** <code class="text-violet-600 dark:text-violet-400">string</code> **<code class="text-violet-600 dark:text-violet-400">actionName</code>**
Absolute path of the directory that was changed to.</p><p><code>table</code> **<code>args</code>** Absolute path of the directory that was changed to.</p><p><code class="text-violet-600 dark:text-violet-400">table</code> **<code class="text-violet-600 dark:text-violet-400">args</code>**
Table of args relating to the Vim action.</p><p>&lt;hr&gt;</p></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> Table of args relating to the Vim action.</p><p>&lt;hr&gt;</p></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="http://localhost:9080"><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>

3
versions/new-website/docs/hooks/index.html
View File

@ -1,3 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Signals</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Signals</h1><p>Signals are global events emitted with the <a href="../api/bait">Bait</a> module.
For more detail on how to use these signals, you may check the Bait page.</p></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>

4
versions/new-website/docs/hooks/job/index.html
View File

@ -1,3 +1,3 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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></span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl"></h1><p>Note: <code>job</code> refers to a job object. You can check <code>doc jobs</code> for more <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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></span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl"></h1><p>Note: <code class="text-violet-600 dark:text-violet-400">job</code> refers to a job object. You can check <code class="text-violet-600 dark:text-violet-400">doc jobs</code> for more
detail.</p><p>+ <code>job.start</code> -&gt; job &gt; Thrown when a new background job starts.</p><p>+ <code>job.done</code> -&gt; job &gt; Thrown when a background jobs exits.</p></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> detail.</p><p>+ <code class="text-violet-600 dark:text-violet-400">job.start</code> -&gt; job &gt; Thrown when a new background job starts.</p><p>+ <code class="text-violet-600 dark:text-violet-400">job.done</code> -&gt; job &gt; Thrown when a background jobs exits.</p></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="http://localhost:9080"><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>

16
versions/new-website/docs/hooks/signal/index.html
View File

@ -1,13 +1,13 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Signal</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Signal</h1><h2 class="font-bold text-3xl" id="signal.sigint-Thrown-when-Hilbish-receive-the-SIGINT-signal-aka-when-Ctrl-C-is-pressed.">signal.sigint <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Signal</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Signal</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="signal.sigint-Thrown-when-Hilbish-receive-the-SIGINT-signal-aka-when-Ctrl-C-is-pressed.">signal.sigint
Thrown when Hilbish receive the SIGINT signal, Thrown when Hilbish receive the SIGINT signal,
aka when Ctrl-C is pressed.</h2><p class="font-bold text-xl" id="Variables-This-signal-returns-no-variables.">Variables aka when Ctrl-C is pressed.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Variables-This-signal-returns-no-variables.">Variables
This signal returns no variables.</p><p>&lt;hr&gt; This signal returns no variables.</p><p>&lt;hr&gt;
## signal.resize ## signal.resize
Thrown when the terminal is resized.</p><p class="font-bold text-xl">Variables Thrown when the terminal is resized.</p><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Variables
This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="signal.sigusr1-Thrown-when-SIGUSR1-is-sent-to-Hilbish.">signal.sigusr1 This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="signal.sigusr1-Thrown-when-SIGUSR1-is-sent-to-Hilbish.">signal.sigusr1
Thrown when SIGUSR1 is sent to Hilbish.</h2><p class="font-bold text-xl">Variables Thrown when SIGUSR1 is sent to Hilbish.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Variables
This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="font-bold text-3xl" id="signal.sigusr2-Thrown-when-SIGUSR2-is-sent-to-Hilbish.">signal.sigusr2 This signal returns no variables.</p><p>&lt;hr&gt;</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="signal.sigusr2-Thrown-when-SIGUSR2-is-sent-to-Hilbish.">signal.sigusr2
Thrown when SIGUSR2 is sent to Hilbish.</h2><p class="font-bold text-xl">Variables Thrown when SIGUSR2 is sent to Hilbish.</h2><p class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Variables
This signal returns no variables.</p></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> This signal returns no variables.</p></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="http://localhost:9080"><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>

12
versions/new-website/docs/index.html
View File

@ -1,5 +1,9 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Introduction</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Introduction</h1><p>Hilbish is a hyper-extensible shell mainly intended for interactive use. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Nature</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Nature</h1><p>A bit after creation, we have the outside nature. Little plants, seeds,
To enhance the interactive experience, Hilbish comes with a wide range growing to their final phase: a full plant. A lot of Hilbish itself is
of features and sane defaults, including a nice looking prompt, written in Go, but there are parts made in Lua, being most builtins
advanced completion menus and history search.</p><p>Here documents some of the features of Hilbish and the Lua API.</p></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> (<code class="text-violet-600 dark:text-violet-400">doc</code>, <code class="text-violet-600 dark:text-violet-400">cd</code>, cdr), completions, and other things.</p><p>Hilbish&#39;s Lua core module is called <code class="text-violet-600 dark:text-violet-400">nature</code>.
It runs after Hilbish&#39;s Go core does.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Nature-Modules-Currently-nature-provides-1-intended-public-module:-nature.dirs.-It-is-a-simple-API-for-managing-recent-directories-and-old-current-working-directory.">Nature Modules
Currently, <code class="text-violet-600 dark:text-violet-400">nature</code> provides 1 intended public module: <code class="text-violet-600 dark:text-violet-400">nature.dirs</code>.
It is a simple API for managing recent directories and old
current working directory.</h1></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="http://localhost:9080"><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>

44
versions/new-website/docs/jobs/index.html
View File

@ -1,30 +1,30 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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></span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl"></h1><p>(This has mainly been replaced by <a href="../api/hilbish.jobs">hilbish.jobs</a>).</p><p>Hilbish has pretty standard job control. It&#39;s missing one or two things, <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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></span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl"></h1><p>(This has mainly been replaced by <a href="../api/hilbish.jobs">hilbish.jobs</a>).</p><p>Hilbish has pretty standard job control. It&#39;s missing one or two things,
but works well. One thing which is different from other shells but works well. One thing which is different from other shells
(besides Hilbish) itself is the API for jobs, and of course it&#39;s in Lua. (besides Hilbish) itself is the API for jobs, and of course it&#39;s in Lua.
You can add jobs, stop and delete (disown) them and even get output.</p><h1 class="font-bold text-4xl" id="Job-Interface-The-job-interface-refers-to-hilbish.jobs.">Job Interface You can add jobs, stop and delete (disown) them and even get output.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Job-Interface-The-job-interface-refers-to-hilbish.jobs.">Job Interface
The job interface refers to <code>hilbish.jobs</code>.</h1><h2 class="font-bold text-3xl" id="Functions-(Note-that-in-the-list-here-they&#39;re-called-from-hilbish.jobs-so-a-listing-of-foo-would-mean-hilbish.jobs.foo)">Functions The job interface refers to <code class="text-violet-600 dark:text-violet-400">hilbish.jobs</code>.</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions-(Note-that-in-the-list-here-they&#39;re-called-from-hilbish.jobs-so-a-listing-of-foo-would-mean-hilbish.jobs.foo)">Functions
(Note that in the list here, they&#39;re called from <code>hilbish.jobs</code>, so (Note that in the list here, they&#39;re called from <code class="text-violet-600 dark:text-violet-400">hilbish.jobs</code>, so
a listing of <code>foo</code> would mean <code>hilbish.jobs.foo</code>)</h2><ul style="list-style-type:&#39;-&#39;;"><li><p><code>all()</code> -&gt; {jobs}: Returns a table of all jobs.</p></li><li><p><code>last()</code> -&gt; job: Returns the last added job.</p></li><li><p><code>get(id)</code> -&gt; job: Get a job by its ID.</p></li><li><p><code>add(cmdstr, args, execPath)</code> -&gt; job: Adds a new job to the job table.</p></li></ul><p>Note that this does not run the command; You have to start it manually. a listing of <code class="text-violet-600 dark:text-violet-400">foo</code> would mean <code class="text-violet-600 dark:text-violet-400">hilbish.jobs.foo</code>)</h2><ul style="list-style-type:&#39;-&#39;;"><li><p><code class="text-violet-600 dark:text-violet-400">all()</code> -&gt; {jobs}: Returns a table of all jobs.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">last()</code> -&gt; job: Returns the last added job.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">get(id)</code> -&gt; job: Get a job by its ID.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">add(cmdstr, args, execPath)</code> -&gt; job: Adds a new job to the job table.</p></li></ul><p>Note that this does not run the command; You have to start it manually.
<code>cmdstr</code> is the user&#39;s input for the job, <code>args</code> is a table of arguments <code class="text-violet-600 dark:text-violet-400">cmdstr</code> is the user&#39;s input for the job, <code class="text-violet-600 dark:text-violet-400">args</code> is a table of arguments
for the command. It includes arg0 (don&#39;t set it as entry 0 in the table) for the command. It includes arg0 (don&#39;t set it as entry 0 in the table)
and <code>execPath</code> is an absolute path for the command executable. and <code class="text-violet-600 dark:text-violet-400">execPath</code> is an absolute path for the command executable.
- <code>disown(id)</code>: Removes a job by ID from the job table.</p><h1 class="font-bold text-4xl" id="Job-Object-A-job-object-is-a-piece-of-userdata.-All-the-functions-of-a-job-require-you-to-call-them-with-a-colon-since-they-are-methods-for-the-job-object.-Example:-hilbish.jobs.last():foreground()-Which-will-foreground-the-last-job.">Job Object - <code class="text-violet-600 dark:text-violet-400">disown(id)</code>: Removes a job by ID from the job table.</p><h1 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Job-Object-A-job-object-is-a-piece-of-userdata.-All-the-functions-of-a-job-require-you-to-call-them-with-a-colon-since-they-are-methods-for-the-job-object.-Example:-hilbish.jobs.last():foreground()-Which-will-foreground-the-last-job.">Job Object
A job object is a piece of <code>userdata</code>. All the functions of a job require A job object is a piece of <code class="text-violet-600 dark:text-violet-400">userdata</code>. All the functions of a job require
you to call them with a colon, since they are <strong>methods</strong> for the job object. you to call them with a colon, since they are <strong>methods</strong> for the job object.
Example: hilbish.jobs.last():foreground() Example: hilbish.jobs.last():foreground()
Which will foreground the last job.</h1><p>You can still have a job object for a disowned job, Which will foreground the last job.</h1><p>You can still have a job object for a disowned job,
it just won&#39;t be <strong>working</strong> anywhere. :^)</p><h2 class="font-bold text-3xl" id="Properties---cmd:-command-string---running:-boolean-whether-the-job-is-running---id:-unique-id-for-the-job---pid:-process-id-for-the-job---exitCode:-exit-code-of-the-job-In-ordinary-cases-you&#39;d-prefer-to-use-the-id-instead-of-pid.-The-id-is-unique-to-Hilbish-and-is-how-you-get-jobs-with-the-hilbish.jobs-interface.-It-may-also-not-describe-the-job-entirely.">Properties it just won&#39;t be <strong>working</strong> anywhere. :^)</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Properties---cmd:-command-string---running:-boolean-whether-the-job-is-running---id:-unique-id-for-the-job---pid:-process-id-for-the-job---exitCode:-exit-code-of-the-job-In-ordinary-cases-you&#39;d-prefer-to-use-the-id-instead-of-pid.-The-id-is-unique-to-Hilbish-and-is-how-you-get-jobs-with-the-hilbish.jobs-interface.-It-may-also-not-describe-the-job-entirely.">Properties
- <code>cmd</code>: command string - <code class="text-violet-600 dark:text-violet-400">cmd</code>: command string
- <code>running</code>: boolean whether the job is running - <code class="text-violet-600 dark:text-violet-400">running</code>: boolean whether the job is running
- <code>id</code>: unique id for the job - <code class="text-violet-600 dark:text-violet-400">id</code>: unique id for the job
- <code>pid</code>: process id for the job - <code class="text-violet-600 dark:text-violet-400">pid</code>: process id for the job
- <code>exitCode</code>: exit code of the job - <code class="text-violet-600 dark:text-violet-400">exitCode</code>: exit code of the job
In ordinary cases you&#39;d prefer to use the <code>id</code> instead of <code>pid</code>. In ordinary cases you&#39;d prefer to use the <code class="text-violet-600 dark:text-violet-400">id</code> instead of <code class="text-violet-600 dark:text-violet-400">pid</code>.
The <code>id</code> is unique to Hilbish and is how you get jobs with the The <code class="text-violet-600 dark:text-violet-400">id</code> is unique to Hilbish and is how you get jobs with the
<code>hilbish.jobs</code> interface. It may also not describe the job entirely.</h2><h2 class="font-bold text-3xl" id="Functions---stop():-Stops-the-job.---start():-Starts-the-job.---foreground():-Set-the-job-as-the-current-running-foreground-process-or-run-it-in-the-foreground-after-it-has-been-suspended.---background():-Run-the-job-in-the-background-after-it-has-been-suspended.">Functions <code class="text-violet-600 dark:text-violet-400">hilbish.jobs</code> interface. It may also not describe the job entirely.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions---stop():-Stops-the-job.---start():-Starts-the-job.---foreground():-Set-the-job-as-the-current-running-foreground-process-or-run-it-in-the-foreground-after-it-has-been-suspended.---background():-Run-the-job-in-the-background-after-it-has-been-suspended.">Functions
- <code>stop()</code>: Stops the job. - <code class="text-violet-600 dark:text-violet-400">stop()</code>: Stops the job.
- <code>start()</code>: Starts the job. - <code class="text-violet-600 dark:text-violet-400">start()</code>: Starts the job.
- <code>foreground()</code>: Set the job as the current running foreground process, or - <code class="text-violet-600 dark:text-violet-400">foreground()</code>: Set the job as the current running foreground process, or
run it in the foreground after it has been suspended. run it in the foreground after it has been suspended.
- <code>background()</code>: Run the job in the background after it has been suspended.</h2></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> - <code class="text-violet-600 dark:text-violet-400">background()</code>: Run the job in the background after it has been suspended.</h2></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="http://localhost:9080"><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>

10
versions/new-website/docs/lunacolors/index.html
View File

@ -1,8 +1,8 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Lunacolors</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Lunacolors</h1><p>Lunacolors is an ANSI color/styling library for Lua. It is included <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Lunacolors</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Lunacolors</h1><p>Lunacolors is an ANSI color/styling library for Lua. It is included
by default in standard Hilbish distributions to provide easy styling by default in standard Hilbish distributions to provide easy styling
for things like prompts and text.</p><p>For simple usage, a single color or style is enough. For example, for things like prompts and text.</p><p>For simple usage, a single color or style is enough. For example,
you can just use <code>lunacolors.blue &#39;Hello world&#39;</code> and that&#39;ll return you can just use <code class="text-violet-600 dark:text-violet-400">lunacolors.blue &#39;Hello world&#39;</code> and that&#39;ll return
blue text which you can print. This includes styles like bold, blue text which you can print. This includes styles like bold,
underline, etc.</p><p>In other usage, you may want to use a format string instead of having underline, etc.</p><p>In other usage, you may want to use a format string instead of having
multiple nested functions for different styles. This is where the format multiple nested functions for different styles. This is where the format
@ -24,7 +24,7 @@ Styles:
- italic - italic
- underline - underline
- invert</p><p>For the colors, there are background and bright variants. Background color - invert</p><p>For the colors, there are background and bright variants. Background color
variants have a <code>Bg</code> suffix, while bright variants use the <code>bright</code> prefix. variants have a <code class="text-violet-600 dark:text-violet-400">Bg</code> suffix, while bright variants use the <code class="text-violet-600 dark:text-violet-400">bright</code> prefix.
These can also be combined. Note that appropriate camel casing must be applied. These can also be combined. Note that appropriate camel casing must be applied.
For example, bright blue would be written as <code>brightBlue</code>, a cyan background as For example, bright blue would be written as <code class="text-violet-600 dark:text-violet-400">brightBlue</code>, a cyan background as
<code>cyanBg</code>, and combining them would result in <code>brightBlueBg</code>.</p></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> <code class="text-violet-600 dark:text-violet-400">cyanBg</code>, and combining them would result in <code class="text-violet-600 dark:text-violet-400">brightBlueBg</code>.</p></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="http://localhost:9080"><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>

24
versions/new-website/docs/nature/dirs/index.html
View File

@ -1,14 +1,14 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module dirs</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module dirs</h1><h2 class="font-bold text-3xl" id="Introduction-The-dirs-module-defines-a-small-set-of-functions-to-store-and-manage-directories.">Introduction <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module dirs</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module dirs</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction-The-dirs-module-defines-a-small-set-of-functions-to-store-and-manage-directories.">Introduction
The dirs module defines a small set of functions to store and manage The dirs module defines a small set of functions to store and manage
directories.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;setOld&quot;&gt;setOld(d)&lt;/a&gt;|Sets-the-old-directory-string.|-|&lt;a-href=&quot;recent&quot;&gt;recent(idx)&lt;/a&gt;|Get-entry-from-recent-directories-list-based-on-index.|-|&lt;a-href=&quot;push&quot;&gt;push(dir)&lt;/a&gt;|Add-dir-to-the-recent-directories-list.|-|&lt;a-href=&quot;pop&quot;&gt;pop(num)&lt;/a&gt;|Remove-the-specified-amount-of-dirs-from-the-recent-directories-list.|-|&lt;a-href=&quot;peak&quot;&gt;peak(num)&lt;/a&gt;|Look-at-num-amount-of-recent-directories-starting-from-the-latest.|-&lt;hr&gt;-&lt;div-id=&#39;peak&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-dirs.peak(num)-&lt;a-href=&quot;peak&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions directories.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;setOld&quot;&gt;setOld(d)&lt;/a&gt;|Sets-the-old-directory-string.|-|&lt;a-href=&quot;recent&quot;&gt;recent(idx)&lt;/a&gt;|Get-entry-from-recent-directories-list-based-on-index.|-|&lt;a-href=&quot;push&quot;&gt;push(dir)&lt;/a&gt;|Add-dir-to-the-recent-directories-list.|-|&lt;a-href=&quot;pop&quot;&gt;pop(num)&lt;/a&gt;|Remove-the-specified-amount-of-dirs-from-the-recent-directories-list.|-|&lt;a-href=&quot;peak&quot;&gt;peak(num)&lt;/a&gt;|Look-at-num-amount-of-recent-directories-starting-from-the-latest.|-&lt;hr&gt;-&lt;div-id=&#39;peak&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-dirs.peak(num)-&lt;a-href=&quot;peak&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions
||| |||
|----|----| |----|----|
|&lt;a href=&quot;#setOld&quot;&gt;setOld(d)&lt;/a&gt;|Sets the old directory string.| |&lt;a href=&quot;#setOld&quot;&gt;setOld(d)&lt;/a&gt;|Sets the old directory string.|
|&lt;a href=&quot;#recent&quot;&gt;recent(idx)&lt;/a&gt;|Get entry from recent directories list based on index.| |&lt;a href=&quot;#recent&quot;&gt;recent(idx)&lt;/a&gt;|Get entry from recent directories list based on index.|
|&lt;a href=&quot;#push&quot;&gt;push(dir)&lt;/a&gt;|Add <code>dir</code> to the recent directories list.| |&lt;a href=&quot;#push&quot;&gt;push(dir)&lt;/a&gt;|Add <code class="text-violet-600 dark:text-violet-400">dir</code> to the recent directories list.|
|&lt;a href=&quot;#pop&quot;&gt;pop(num)&lt;/a&gt;|Remove the specified amount of dirs from the recent directories list.| |&lt;a href=&quot;#pop&quot;&gt;pop(num)&lt;/a&gt;|Remove the specified amount of dirs from the recent directories list.|
|&lt;a href=&quot;#peak&quot;&gt;peak(num)&lt;/a&gt;|Look at <code>num</code> amount of recent directories, starting from the latest.| |&lt;a href=&quot;#peak&quot;&gt;peak(num)&lt;/a&gt;|Look at <code class="text-violet-600 dark:text-violet-400">num</code> amount of recent directories, starting from the latest.|
&lt;hr&gt; &lt;hr&gt;
&lt;div id=&#39;peak&#39;&gt; &lt;div id=&#39;peak&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
@ -16,10 +16,10 @@ dirs.peak(num)
&lt;a href=&quot;#peak&quot; class=&#39;heading-link&#39;&gt; &lt;a href=&quot;#peak&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; &lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt; &lt;/a&gt;
&lt;/h4&gt;</h2><p>Look at <code>num</code> amount of recent directories, starting from the latest. &lt;/h4&gt;</h2><p>Look at <code class="text-violet-600 dark:text-violet-400">num</code> amount of recent directories, starting from the latest.
This returns a table of recent directories, up to the <code>num</code> amount. This returns a table of recent directories, up to the <code class="text-violet-600 dark:text-violet-400">num</code> amount.
#### Parameters #### Parameters
<code>num</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <code class="text-violet-600 dark:text-violet-400">num</code> **<code class="text-violet-600 dark:text-violet-400">number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;pop&#39;&gt; &lt;div id=&#39;pop&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
dirs.pop(num) dirs.pop(num)
@ -28,16 +28,16 @@ dirs.pop(num)
&lt;/a&gt; &lt;/a&gt;
&lt;/h4&gt;</p><p>Remove the specified amount of dirs from the recent directories list. &lt;/h4&gt;</p><p>Remove the specified amount of dirs from the recent directories list.
#### Parameters #### Parameters
<code>num</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <code class="text-violet-600 dark:text-violet-400">num</code> **<code class="text-violet-600 dark:text-violet-400">number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;push&#39;&gt; &lt;div id=&#39;push&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
dirs.push(dir) dirs.push(dir)
&lt;a href=&quot;#push&quot; class=&#39;heading-link&#39;&gt; &lt;a href=&quot;#push&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt; &lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt; &lt;/a&gt;
&lt;/h4&gt;</p><p>Add <code>dir</code> to the recent directories list. &lt;/h4&gt;</p><p>Add <code class="text-violet-600 dark:text-violet-400">dir</code> to the recent directories list.
#### Parameters #### Parameters
<code>dir</code> **<code>string</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <code class="text-violet-600 dark:text-violet-400">dir</code> **<code class="text-violet-600 dark:text-violet-400">string</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;recent&#39;&gt; &lt;div id=&#39;recent&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
dirs.recent(idx) dirs.recent(idx)
@ -46,7 +46,7 @@ dirs.recent(idx)
&lt;/a&gt; &lt;/a&gt;
&lt;/h4&gt;</p><p>Get entry from recent directories list based on index. &lt;/h4&gt;</p><p>Get entry from recent directories list based on index.
#### Parameters #### Parameters
<code>idx</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <code class="text-violet-600 dark:text-violet-400">idx</code> **<code class="text-violet-600 dark:text-violet-400">number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;setOld&#39;&gt; &lt;div id=&#39;setOld&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
dirs.setOld(d) dirs.setOld(d)
@ -55,4 +55,4 @@ dirs.setOld(d)
&lt;/a&gt; &lt;/a&gt;
&lt;/h4&gt;</p><p>Sets the old directory string. &lt;/h4&gt;</p><p>Sets the old directory string.
#### Parameters #### Parameters
<code>d</code> **<code>string</code>** </p><p>&lt;/div&gt;</p></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> <code class="text-violet-600 dark:text-violet-400">d</code> **<code class="text-violet-600 dark:text-violet-400">string</code>** </p><p>&lt;/div&gt;</p></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="http://localhost:9080"><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>

12
versions/new-website/docs/nature/doc/index.html
View File

@ -1,9 +1,9 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Module doc</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Module doc</h1><h2 class="font-bold text-3xl" id="Introduction-The-doc-module-contains-a-small-set-of-functions-used-by-the-Greenhouse-pager-to-render-parts-of-the-documentation-pages.-This-is-only-documented-for-the-sake-of-it.-It&#39;s-only-intended-use-is-by-the-Greenhouse-pager.">Introduction <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Module doc</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Module doc</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction-The-doc-module-contains-a-small-set-of-functions-used-by-the-Greenhouse-pager-to-render-parts-of-the-documentation-pages.-This-is-only-documented-for-the-sake-of-it.-It&#39;s-only-intended-use-is-by-the-Greenhouse-pager.">Introduction
The doc module contains a small set of functions The doc module contains a small set of functions
used by the Greenhouse pager to render parts of the documentation pages. used by the Greenhouse pager to render parts of the documentation pages.
This is only documented for the sake of it. It&#39;s only intended use This is only documented for the sake of it. It&#39;s only intended use
is by the Greenhouse pager.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;renderInfoBlock&quot;&gt;renderInfoBlock(type-text)&lt;/a&gt;|Renders-an-info-block.-An-info-block-is-a-block-of-text-with|-|&lt;a-href=&quot;renderCodeBlock&quot;&gt;renderCodeBlock(text)&lt;/a&gt;|Assembles-and-renders-a-code-block.-This-returns|-|&lt;a-href=&quot;highlight&quot;&gt;highlight(text)&lt;/a&gt;|Performs-basic-Lua-code-highlighting.|-&lt;hr&gt;-&lt;div-id=&#39;highlight&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-doc.highlight(text)-&lt;a-href=&quot;highlight&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions is by the Greenhouse pager.</h2><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;renderInfoBlock&quot;&gt;renderInfoBlock(type-text)&lt;/a&gt;|Renders-an-info-block.-An-info-block-is-a-block-of-text-with|-|&lt;a-href=&quot;renderCodeBlock&quot;&gt;renderCodeBlock(text)&lt;/a&gt;|Assembles-and-renders-a-code-block.-This-returns|-|&lt;a-href=&quot;highlight&quot;&gt;highlight(text)&lt;/a&gt;|Performs-basic-Lua-code-highlighting.|-&lt;hr&gt;-&lt;div-id=&#39;highlight&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-doc.highlight(text)-&lt;a-href=&quot;highlight&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions
||| |||
|----|----| |----|----|
|&lt;a href=&quot;#renderInfoBlock&quot;&gt;renderInfoBlock(type, text)&lt;/a&gt;|Renders an info block. An info block is a block of text with| |&lt;a href=&quot;#renderInfoBlock&quot;&gt;renderInfoBlock(type, text)&lt;/a&gt;|Renders an info block. An info block is a block of text with|
@ -18,7 +18,7 @@ doc.highlight(text)
&lt;/a&gt; &lt;/a&gt;
&lt;/h4&gt;</h2><p>Performs basic Lua code highlighting. &lt;/h4&gt;</h2><p>Performs basic Lua code highlighting.
#### Parameters #### Parameters
<code>text</code> **<code>string</code>** <code class="text-violet-600 dark:text-violet-400">text</code> **<code class="text-violet-600 dark:text-violet-400">string</code>**
Code/text to do highlighting on.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt; Code/text to do highlighting on.</p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;renderCodeBlock&#39;&gt; &lt;div id=&#39;renderCodeBlock&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
@ -30,7 +30,7 @@ doc.renderCodeBlock(text)
the supplied text based on the number of command line columns, the supplied text based on the number of command line columns,
and styles it to resemble a code block. and styles it to resemble a code block.
#### Parameters #### Parameters
<code>text</code> **<code>string</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt; <code class="text-violet-600 dark:text-violet-400">text</code> **<code class="text-violet-600 dark:text-violet-400">string</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;renderInfoBlock&#39;&gt; &lt;div id=&#39;renderInfoBlock&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt; &lt;h4 class=&#39;heading&#39;&gt;
doc.renderInfoBlock(type, text) doc.renderInfoBlock(type, text)
@ -40,5 +40,5 @@ doc.renderInfoBlock(type, text)
&lt;/h4&gt;</p><p>Renders an info block. An info block is a block of text with &lt;/h4&gt;</p><p>Renders an info block. An info block is a block of text with
an icon and styled text block. an icon and styled text block.
#### Parameters #### Parameters
<code>type</code> **<code>string</code>** <code class="text-violet-600 dark:text-violet-400">type</code> **<code class="text-violet-600 dark:text-violet-400">string</code>**
Type of info block. The only one specially styled is the <code>warning</code>.</p><p><code>text</code> **<code>string</code>** </p><p>&lt;/div&gt;</p></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> Type of info block. The only one specially styled is the <code class="text-violet-600 dark:text-violet-400">warning</code>.</p><p><code class="text-violet-600 dark:text-violet-400">text</code> **<code class="text-violet-600 dark:text-violet-400">string</code>** </p><p>&lt;/div&gt;</p></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="http://localhost:9080"><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>

9
versions/new-website/docs/nature/index.html
View File

@ -1,9 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Nature</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Nature</h1><p>A bit after creation, we have the outside nature. Little plants, seeds,
growing to their final phase: a full plant. A lot of Hilbish itself is
written in Go, but there are parts made in Lua, being most builtins
(<code>doc</code>, <code>cd</code>, cdr), completions, and other things.</p><p>Hilbish&#39;s Lua core module is called <code>nature</code>.
It runs after Hilbish&#39;s Go core does.</p><h1 class="font-bold text-4xl" id="Nature-Modules-Currently-nature-provides-1-intended-public-module:-nature.dirs.-It-is-a-simple-API-for-managing-recent-directories-and-old-current-working-directory.">Nature Modules
Currently, <code>nature</code> provides 1 intended public module: <code>nature.dirs</code>.
It is a simple API for managing recent directories and old
current working directory.</h1></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>

2
versions/new-website/docs/timers/index.html
View File

@ -1,2 +1,2 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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></span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl"></h1><p>This has been moved to the <code>hilbish.timers</code> API doc (accessible by <code>doc api hilbish.timers</code>)</p></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> <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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></span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl"></h1><p>This has been moved to the <code class="text-violet-600 dark:text-violet-400">hilbish.timers</code> API doc (accessible by <code class="text-violet-600 dark:text-violet-400">doc api hilbish.timers</code>)</p></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="http://localhost:9080"><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>

3
versions/new-website/docs/vi/index.html Normal file
View File

@ -0,0 +1,3 @@
<!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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Vim Mode</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Vim Mode</h1><p>Hilbish has a Vim binding input mode accessible for use.
It can be enabled with the <code class="text-violet-600 dark:text-violet-400">hilbish.inputMode</code> function (check <code class="text-violet-600 dark:text-violet-400">doc hilbish</code>).</p><p>This is documentation for everything relating to it.</p></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="http://localhost:9080"><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>

6
versions/new-website/docs/vim-mode/actions/index.html
View File

@ -1,7 +1,7 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Actions</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Actions</h1><p>Vim actions are essentially just when a user uses a Vim keybind. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Actions</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Actions</h1><p>Vim actions are essentially just when a user uses a Vim keybind.
Things like yanking and pasting are Vim actions. Things like yanking and pasting are Vim actions.
This is not an &quot;offical Vim thing,&quot; just a Hilbish thing.</p><p>The <code>hilbish.vimAction</code> hook is thrown whenever a Vim action occurs. This is not an &quot;offical Vim thing,&quot; just a Hilbish thing.</p><p>The <code class="text-violet-600 dark:text-violet-400">hilbish.vimAction</code> hook is thrown whenever a Vim action occurs.
It passes 2 arguments: the action name, and an array (table) of args It passes 2 arguments: the action name, and an array (table) of args
relating to it.</p><p>Here is documentation for what the table of args will hold for an relating to it.</p><p>Here is documentation for what the table of args will hold for an
appropriate Vim action.</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code>yank</code>: register, yankedText</p></li></ul><p>The first argument for the yank action is the register yankedText goes to.</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code>paste</code>: register, pastedText</p></li></ul><p>The first argument for the paste action is the register pastedText is taken from.</p></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> appropriate Vim action.</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code class="text-violet-600 dark:text-violet-400">yank</code>: register, yankedText</p></li></ul><p>The first argument for the yank action is the register yankedText goes to.</p><ul style="list-style-type:&#39;-&#39;;"><li><p><code class="text-violet-600 dark:text-violet-400">paste</code>: register, pastedText</p></li></ul><p>The first argument for the paste action is the register pastedText is taken from.</p></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="http://localhost:9080"><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>

3
versions/new-website/docs/vim-mode/index.html
View File

@ -1,3 +0,0 @@
<!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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Vim Mode</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Vim Mode</h1><p>Hilbish has a Vim binding input mode accessible for use.
It can be enabled with the <code>hilbish.inputMode</code> function (check <code>doc hilbish</code>).</p><p>This is documentation for everything relating to it.</p></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>

4
versions/new-website/index.html
View File

@ -1,8 +1,8 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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><main class="flex flex-col gap-4 mx-4"><div class="border-b border-b-zinc-300 gap-3 -mx-4 p-2 h-screen bg-radial-[at_100%_100%] from-pink-500 to-stone-50 dark:to-neutral-950 to-35% flex flex-col items-center justify-center"><div class="gap-1 flex flex-col items-center"><span class="flex flex-row items-center justify-center"><img class="h-20" src="./hilbish-flower.png"><p class="text-4xl font-bold">Hilbish</p></span><p class="text-4xl font-light">Something Unique.</p></div><p class="text-center">Hilbish is the new Moon-powered interactive shell for Lua fans!<br>Extensible, scriptable, configurable: All in Lua.</p><div class="flex flex-row gap-2 mt-2"><a href target="_blank"><button class="bg-pink-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">Install</button></a><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">GitHub</button></a></div><p class="absolute bottom-4">Scroll for more</p></div><div class="text-center"><span class="rounded-md backdrop-blur-md bg-pink-500/20 p-2 text-xs font-light">Feature Overview</span><div class="flex flex-col justify-center items-center gap-6 mt-4"><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-start"><h1 class="text-4xl font-semibold">The Moon-powered shell</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 "><img class="h-32 rounded-md" src="https://upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Lua-Logo.svg/2048px-Lua-Logo.svg.png"><p>Hilbish makes use of the Lua programming language for interactive and config scripting. <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><main class="flex flex-col gap-4 mx-4"><div class="border-b border-b-zinc-300 gap-3 -mx-4 p-2 h-screen bg-radial-[at_100%_100%] from-pink-500 to-stone-50 dark:to-neutral-950 to-35% flex flex-col items-center justify-center"><div class="gap-1 flex flex-col items-center"><span class="flex flex-row items-center justify-center"><img class="h-20" src="./hilbish-flower.png"><p class="text-4xl font-bold">Hilbish</p></span><p class="text-4xl font-light">Something Unique.</p></div><p class="text-center">Hilbish is the new Moon-powered interactive shell for Lua fans!<br>Extensible, scriptable, configurable: All in Lua.</p><div class="flex flex-row gap-2 mt-2"><a href target="_blank"><button class="bg-pink-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">Install</button></a><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">GitHub</button></a></div><p class="absolute bottom-4">Scroll for more</p></div><div class="text-center"><span class="rounded-md backdrop-blur-md bg-pink-500/20 p-2 text-xs font-light">Feature Overview</span><div class="flex flex-col justify-center items-center gap-6 mt-4"><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-start"><h1 class="text-4xl font-semibold">The Moon-powered shell</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 "><img class="h-32 rounded-md" src="https://upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Lua-Logo.svg/2048px-Lua-Logo.svg.png"><p>Hilbish makes use of the Lua programming language for interactive and config scripting.
If you write Lua on a regular basis, Hilbish will be the perfect resident in your terminal. If you write Lua on a regular basis, Hilbish will be the perfect resident in your terminal.
You can still use shell script, but Lua takes the spotlight (or the moonlight..)</p></div></div><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-end"><h1 class="text-4xl font-semibold">Modern, Helpful Interactive Features</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 flex-row-reverse"><img class="h-32 rounded-md" src="https://safe.saya.moe/osR0bplExBC0.png"><p>Graphical TUI history, sensible tab completions, elegantly refreshing prompts, name it all and Hilbish either has it or it&#39;s 1 suggestion or 1 script away from being possible. You can still use shell script, but Lua takes the spotlight (or the moonlight..)</p></div></div><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-end"><h1 class="text-4xl font-semibold">Modern, Helpful Interactive Features</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 flex-row-reverse"><img class="h-32 rounded-md" src="https://safe.saya.moe/osR0bplExBC0.png"><p>Graphical TUI history, sensible tab completions, elegantly refreshing prompts, name it all and Hilbish either has it or it&#39;s 1 suggestion or 1 script away from being possible.
Everything present in Hilbish is meant to enhance your interactive shell experience.</p></div></div><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-start"><h1 class="text-4xl font-semibold">Sensible, Friendly Defaults</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 "><img class="h-32 rounded-md" src="https://safe.saya.moe/7ze8NQVPD9vO.png"><p>Hilbish&#39;s default config makes a simple but presentable showcase of its Lua API and a few of its features.</p></div></div><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-end"><h1 class="text-4xl font-semibold">Truly Make It Yours</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 flex-row-reverse"><p>Many things about Hilbish are designed to be changed and swapped out. Everything present in Hilbish is meant to enhance your interactive shell experience.</p></div></div><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-start"><h1 class="text-4xl font-semibold">Sensible, Friendly Defaults</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 "><img class="h-32 rounded-md" src="https://safe.saya.moe/7ze8NQVPD9vO.png"><p>Hilbish&#39;s default config makes a simple but presentable showcase of its Lua API and a few of its features.</p></div></div><div class="flex flex-col gap-2 md:w-3/6 text-start xl:items-end"><h1 class="text-4xl font-semibold">Truly Make It Yours</h1><div class="flex flex-row flex-wrap xl:flex-nowrap justify-center items-center gap-4 flex-row-reverse"><p>Many things about Hilbish are designed to be changed and swapped out.
If you want to make use of a Lua derivative in your interactive use (like Fennel) instead of If you want to make use of a Lua derivative in your interactive use (like Fennel) instead of
Lua, that can be done!</p></div></div></div></div><div class="text-center bg-neutral-100 dark:bg-neutral-900 -mx-4 p-4"><span class="rounded-md backdrop-blur-md bg-blue-500/20 p-2 text-xs font-light">Download It Now!</span><div class="flex flex-col items-center mt-4 gap-2"><p class="md:w-3/6">To find out all that Hilbish can do, you should just try it out! It&#39;s officially available on Linux, MacOS, Windows, and probably builds on anything Go is available on!</p><h2 class="text-3xl font-semibold">Featured Downloads</h2><p>These are binary releases of Hilbish from GitHub. Install instructions are located at an INSTALL.md file.</p><div class="mt-6 flex flex-row flex-wrap items-center justify-center gap-8"><div class="flex flex-col gap-2"><img class="h-36" src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/35/Tux.svg/1200px-Tux.svg.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">Linux (64-bit)</button></a></div><div class="flex flex-col gap-2"><img class="h-36" src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/0a/Unofficial_Windows_logo_variant_-_2002%E2%80%932012_%28Multicolored%29.svg/2321px-Unofficial_Windows_logo_variant_-_2002%E2%80%932012_%28Multicolored%29.svg.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">Windows (64-bit)</button></a></div><div class="flex flex-col gap-2 justify-center items-center"><img class="h-36" src="https://images.seeklogo.com/logo-png/38/2/apple-mac-os-logo-png_seeklogo-381401.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">MacOS (64-bit)</button></a></div><div class="flex flex-col gap-2 justify-center items-center"><img class="h-36" src="https://images.seeklogo.com/logo-png/38/2/apple-mac-os-logo-png_seeklogo-381401.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">MacOS (ARM)</button></a></div></div></div></div></main><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> Lua, that can be done!</p></div></div></div></div><div class="text-center bg-neutral-100 dark:bg-neutral-900 -mx-4 p-4"><span class="rounded-md backdrop-blur-md bg-blue-500/20 p-2 text-xs font-light">Download It Now!</span><div class="flex flex-col items-center mt-4 gap-2"><p class="md:w-3/6">To find out all that Hilbish can do, you should just try it out! It&#39;s officially available on Linux, MacOS, Windows, and probably builds on anything Go is available on!</p><h2 class="text-3xl font-semibold">Featured Downloads</h2><p>These are binary releases of Hilbish from GitHub. Install instructions are located at an INSTALL.md file.</p><div class="mt-6 flex flex-row flex-wrap items-center justify-center gap-8"><div class="flex flex-col gap-2"><img class="h-36" src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/35/Tux.svg/1200px-Tux.svg.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">Linux (64-bit)</button></a></div><div class="flex flex-col gap-2"><img class="h-36" src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/0a/Unofficial_Windows_logo_variant_-_2002%E2%80%932012_%28Multicolored%29.svg/2321px-Unofficial_Windows_logo_variant_-_2002%E2%80%932012_%28Multicolored%29.svg.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">Windows (64-bit)</button></a></div><div class="flex flex-col gap-2 justify-center items-center"><img class="h-36" src="https://images.seeklogo.com/logo-png/38/2/apple-mac-os-logo-png_seeklogo-381401.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">MacOS (64-bit)</button></a></div><div class="flex flex-col gap-2 justify-center items-center"><img class="h-36" src="https://images.seeklogo.com/logo-png/38/2/apple-mac-os-logo-png_seeklogo-381401.png"><a href target="_blank"><button class="bg-stone-500/30 rounded-md backdrop-blur-md py-2 px-4 font-semibold">MacOS (ARM)</button></a></div></div></div></div></main><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="/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>

36
versions/new-website/install/index.html
View File

@ -1,32 +1,6 @@
<!doctype 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="/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 property="og:url"></head><body class="min-h-screen flex flex-col"><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="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 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>Install</span></div><div class="grid"><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 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full 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">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</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 class="font-bold text-4xl">Install</h1><h2 class="font-bold text-3xl" id="Official-Binaries-The-best-way-to-get-Hilbish-is-to-get-a-build-directly-from-GitHub.-At-any-time-there-are-2-versions-of-Hilbish-recommended-for-download:-the-latest-stable-release-and-development-builds-from-the-master-branch.">Official Binaries <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="min-h-screen flex flex-col"><nav class="bg-stone-50/80 dark:bg-neutral-900/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-18"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-16" src="/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3 dark:text-pink-300 text-pink-600"><a href="/">Home</a><a href="/install">Install</a><a href="/docs">Docs</a><a href="/blog">Blog</a></div></nav><div class="flex-auto flex flex-col overflow-none"><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 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>Install</span></div><div class="h-full sm:flex grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="p-4 border-r border-r-zinc-300 col-start-1 row-start-1 bg-neutral-200 dark:bg-neutral-900 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul><li class="mb-2"><a href="/docs/completions">Completions</a></li><li class="mb-2"><a href="/docs/nature/doc">Module doc</a></li><li class="mb-2"><a href="/docs">Introduction</a></li><li class="mb-2"><a href="/docs/getting-started">Getting Started</a></li><li class="mb-2"><a href="/docs/faq">Frequently Asked Questions</a></li><li class="mb-2"><a href="/docs/lunacolors">Lunacolors</a></li><li class="mb-2"><a href="/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="/docs/nature">Nature</a></li><li class="mb-2"><a href="/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="/docs/api">API</a></li><li class="mb-2"><a href="/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="/docs/features/runner-mode">Runner Mode</a></li><li class="mb-2"><a href="/docs/features/opts">Options</a></li><li class="mb-2"><a href="/docs/features">Features</a></li><li class="mb-2"><a href="/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="/docs/hooks">Signals</a></li><li class="mb-2"><a href="/docs/hooks/command">Command</a></li><li class="mb-2"><a href="/docs/hooks/signal">Signal</a></li><li class="mb-2"><a href="/docs/vim-mode/actions">Actions</a></li><li class="mb-2"><a href="/docs/vim-mode">Vim Mode</a></li></ul></div><main class="mb-4 h-full overflow-y-auto 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 px-4 pt-2"><h1 class="mb-2 font-bold text-4xl">Install</h1><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Official-Binaries">Official Binaries</h2><p>The best way to get Hilbish is to get a build directly from GitHub.</p><p>At any time, there are 2 versions of Hilbish available to install:
The best way to get Hilbish is to get a build directly from GitHub. the latest stable release, and development builds from the master branch.</p><p>You can download both at any time, but note that the development builds may
At any time, there are 2 versions of Hilbish recommended for download: have breaking changes.</p><p>For the latest <strong>stable release</strong>, check here: https://github.com/Rosettea/Hilbish/releases/latest</p><p>For a <strong>development build</strong>: https://nightly.link/Rosettea/Hilbish/workflows/build/master</p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Compiling">Compiling</h2><p>To read the steps for compiling Hilbish, head over to the <a href="https://github.com/Rosettea/Hilbish#build">GitHub repository.</a></p><h2 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Package-Repositories">Package Repositories</h2><p>Methods of installing Hilbish for your Linux distro.</p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="Fedora-(COPR)">Fedora (COPR)</h3><p>An official COPR is offered to install Hilbish easily on Fedora.
the latest stable release, and development builds from the master branch.</h2><p>You can download both at any time, but note that the development builds may Enable the repo: <code class="text-violet-600 dark:text-violet-400">dnf copr enable sammyette/Hilbish</code></p><p>And install Hilbish: <code class="text-violet-600 dark:text-violet-400">dnf install hilbish</code></p><p>Or for the latest development build from master: <code class="text-violet-600 dark:text-violet-400">dnf install hilbish-git</code></p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="Arch-Linux-(AUR)">Arch Linux (AUR)</h3><p>Hilbish is on the AUR. Setup an AUR helper, and install.</p><p>Example with yay: <code class="text-violet-600 dark:text-violet-400">yay -S hilbish</code></p><p>Or, from master branch: <code class="text-violet-600 dark:text-violet-400">yay -S hilbish-git</code></p><h3 class="mb-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="Alpine-Linux">Alpine Linux</h3><p>Hilbish is currentlty in the testing/edge repository for Alpine.
have breaking changes.</p><p>For the latest *<strong>stable release</strong><strong>, check here: https://github.com/Rosettea/Hilbish/releases/latest Follow the steps <a href="https://wiki.alpinelinux.org/wiki/Enable_Community_Repository">here</a> (using testing repositories) and install: <code class="text-violet-600 dark:text-violet-400">apk add hilbish</code></p></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="http://localhost:9080"><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>
For a *</strong>development build**: https://nightly.link/Rosettea/Hilbish/workflows/build/master</p><h2 class="font-bold text-3xl" id="Compiling-To-read-the-steps-for-compiling-Hilbish-head-over-to-the-GitHub-repository.">Compiling
To read the steps for compiling Hilbish, head over to the <a href="https://github.com/Rosettea/Hilbish#build">GitHub repository.</a></h2><h2 class="font-bold text-3xl" id="Package-Repositories-Methods-of-installing-Hilbish-for-your-Linux-distro.">Package Repositories
Methods of installing Hilbish for your Linux distro.</h2><h3 class="font-bold text-2xl" id="Fedora-(COPR)-An-official-COPR-is-offered-to-install-Hilbish-easily-on-Fedora.-Enable-the-repo:--sudo-dnf-copr-enable-sammyette/Hilbish">Fedora (COPR)
An official COPR is offered to install Hilbish easily on Fedora.
Enable the repo:
<code>
sudo dnf copr enable sammyette/Hilbish
</code></h3><p>And install Hilbish:
<code>
sudo dnf install hilbish
</code></p><p>Or for the latest development build from master:
<code>
sudo dnf install hilbish-git
</code></p><h3 class="font-bold text-2xl" id="Arch-Linux-(AUR)-Hilbish-is-on-the-AUR.-Setup-an-AUR-helper-and-install.-Example-with-yay:">Arch Linux (AUR)
Hilbish is on the AUR. Setup an AUR helper, and install.
Example with yay: </h3><pre><code data-lang="text">yay -S hilbish
</code></pre><p>Or, from master branch:
<code>
yay -S hilbish-git
</code></p><h3 class="font-bold text-2xl" id="Alpine-Linux-Hilbish-is-currentlty-in-the-testing/edge-repository-for-Alpine.-Follow-the-steps-here-(Using-testing-repositories)-and-install:----apk-add-hilbish">Alpine Linux
Hilbish is currentlty in the testing/edge repository for Alpine.
Follow the steps <a href="https://wiki.alpinelinux.org/wiki/Enable_Community_Repository">here</a>
(Using testing repositories) and install:
<code>
apk add hilbish
</code></h3></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>

140
versions/new-website/tailwind.css
View File

@ -1,4 +1,4 @@
/*! tailwindcss v4.1.8 | MIT License | https://tailwindcss.com */ /*! tailwindcss v4.1.10 | MIT License | https://tailwindcss.com */
@layer properties; @layer properties;
@layer theme, base, components, utilities; @layer theme, base, components, utilities;
@layer theme { @layer theme {
@ -575,18 +575,12 @@
.top-0 { .top-0 {
top: calc(var(--spacing) * 0); top: calc(var(--spacing) * 0);
} }
.top-22 {
top: calc(var(--spacing) * 22);
}
.right-2 { .right-2 {
right: calc(var(--spacing) * 2); right: calc(var(--spacing) * 2);
} }
.bottom-4 { .bottom-4 {
bottom: calc(var(--spacing) * 4); bottom: calc(var(--spacing) * 4);
} }
.left-0 {
left: calc(var(--spacing) * 0);
}
.isolate { .isolate {
isolation: isolate; isolation: isolate;
} }
@ -728,9 +722,6 @@
.me-auto { .me-auto {
margin-inline-end: auto; margin-inline-end: auto;
} }
.-mt-2 {
margin-top: calc(var(--spacing) * -2);
}
.mt-2 { .mt-2 {
margin-top: calc(var(--spacing) * 2); margin-top: calc(var(--spacing) * 2);
} }
@ -746,8 +737,8 @@
.mt-auto { .mt-auto {
margin-top: auto; margin-top: auto;
} }
.-mb-4 { .mb-1 {
margin-bottom: calc(var(--spacing) * -4); margin-bottom: calc(var(--spacing) * 1);
} }
.mb-2 { .mb-2 {
margin-bottom: calc(var(--spacing) * 2); margin-bottom: calc(var(--spacing) * 2);
@ -864,9 +855,6 @@
width: auto; width: auto;
height: auto; height: auto;
} }
.h-6 {
height: calc(var(--spacing) * 6);
}
.h-8 { .h-8 {
height: calc(var(--spacing) * 8); height: calc(var(--spacing) * 8);
} }
@ -876,8 +864,11 @@
.h-10 { .h-10 {
height: calc(var(--spacing) * 10); height: calc(var(--spacing) * 10);
} }
.h-12 { .h-16 {
height: calc(var(--spacing) * 12); height: calc(var(--spacing) * 16);
}
.h-18 {
height: calc(var(--spacing) * 18);
} }
.h-20 { .h-20 {
height: calc(var(--spacing) * 20); height: calc(var(--spacing) * 20);
@ -933,9 +924,6 @@
.min-h-screen { .min-h-screen {
min-height: 100vh; min-height: 100vh;
} }
.w-64 {
width: calc(var(--spacing) * 64);
}
.w-\[100px\] { .w-\[100px\] {
width: 100px; width: 100px;
} }
@ -1008,8 +996,11 @@
.grow { .grow {
flex-grow: 1; flex-grow: 1;
} }
.basis-3\/5 { .basis-2\/10 {
flex-basis: calc(3/5 * 100%); flex-basis: calc(2/10 * 100%);
}
.basis-7\/7 {
flex-basis: calc(7/7 * 100%);
} }
.basis-auto { .basis-auto {
flex-basis: auto; flex-basis: auto;
@ -1561,6 +1552,9 @@
.overflow-hidden { .overflow-hidden {
overflow: hidden; overflow: hidden;
} }
.overflow-x-auto {
overflow-x: auto;
}
.overflow-y-auto { .overflow-y-auto {
overflow-y: auto; overflow-y: auto;
} }
@ -1704,6 +1698,9 @@
.border-\[\#fbf0df\] { .border-\[\#fbf0df\] {
border-color: #fbf0df; border-color: #fbf0df;
} }
.border-neutral-200 {
border-color: var(--color-neutral-200);
}
.border-t-zinc-300 { .border-t-zinc-300 {
border-top-color: var(--color-zinc-300); border-top-color: var(--color-zinc-300);
} }
@ -1728,9 +1725,6 @@
background-color: color-mix(in oklab, var(--color-blue-500) 20%, transparent); background-color: color-mix(in oklab, var(--color-blue-500) 20%, transparent);
} }
} }
.bg-gray-200 {
background-color: var(--color-gray-200);
}
.bg-neutral-100 { .bg-neutral-100 {
background-color: var(--color-neutral-100); background-color: var(--color-neutral-100);
} }
@ -1755,6 +1749,12 @@
.bg-stone-50 { .bg-stone-50 {
background-color: var(--color-stone-50); background-color: var(--color-stone-50);
} }
.bg-stone-50\/80 {
background-color: color-mix(in srgb, oklch(98.5% 0.001 106.423) 80%, transparent);
@supports (color: color-mix(in lab, red, red)) {
background-color: color-mix(in oklab, var(--color-stone-50) 80%, transparent);
}
}
.bg-stone-500\/30 { .bg-stone-500\/30 {
background-color: color-mix(in srgb, oklch(55.3% 0.013 58.071) 30%, transparent); background-color: color-mix(in srgb, oklch(55.3% 0.013 58.071) 30%, transparent);
@supports (color: color-mix(in lab, red, red)) { @supports (color: color-mix(in lab, red, red)) {
@ -1764,6 +1764,9 @@
.bg-transparent { .bg-transparent {
background-color: transparent; background-color: transparent;
} }
.bg-white {
background-color: var(--color-white);
}
.bg-zinc-300\/50 { .bg-zinc-300\/50 {
background-color: color-mix(in srgb, oklch(87.1% 0.006 286.286) 50%, transparent); background-color: color-mix(in srgb, oklch(87.1% 0.006 286.286) 50%, transparent);
@supports (color: color-mix(in lab, red, red)) { @supports (color: color-mix(in lab, red, red)) {
@ -2412,12 +2415,27 @@
.text-black { .text-black {
color: var(--color-black); color: var(--color-black);
} }
.text-gray-500 {
color: var(--color-gray-500);
}
.text-neutral-400 {
color: var(--color-neutral-400);
}
.text-neutral-500 { .text-neutral-500 {
color: var(--color-neutral-500); color: var(--color-neutral-500);
} }
.text-neutral-800 {
color: var(--color-neutral-800);
}
.text-pink-300 { .text-pink-300 {
color: var(--color-pink-300); color: var(--color-pink-300);
} }
.text-pink-600 {
color: var(--color-pink-600);
}
.text-violet-600 {
color: var(--color-violet-600);
}
.capitalize { .capitalize {
text-transform: capitalize; text-transform: capitalize;
} }
@ -2938,11 +2956,6 @@
} }
} }
} }
.peer-checked\:opacity-50 {
&:is(:where(.peer):checked ~ *) {
opacity: 50%;
}
}
.peer-checked\:blur-sm { .peer-checked\:blur-sm {
&:is(:where(.peer):checked ~ *) { &:is(:where(.peer):checked ~ *) {
--tw-blur: blur(var(--blur-sm)); --tw-blur: blur(var(--blur-sm));
@ -3185,14 +3198,25 @@
} }
} }
} }
.sm\:top-12 { .sm\:flex {
@media (width >= 40rem) { @media (width >= 40rem) {
top: calc(var(--spacing) * 12); display: flex;
} }
} }
.sm\:h-svh { .sm\:hidden {
@media (width >= 40rem) { @media (width >= 40rem) {
height: 100svh; display: none;
}
}
.sm\:translate-x-0 {
@media (width >= 40rem) {
--tw-translate-x: calc(var(--spacing) * 0);
translate: var(--tw-translate-x) var(--tw-translate-y);
}
}
.sm\:rounded-lg {
@media (width >= 40rem) {
border-radius: var(--radius-lg);
} }
} }
.md\:w-3\/6 { .md\:w-3\/6 {
@ -3221,11 +3245,34 @@
align-items: flex-start; align-items: flex-start;
} }
} }
.rtl\:text-right {
&:where(:dir(rtl), [dir="rtl"], [dir="rtl"] *) {
text-align: right;
}
}
.dark\:border-neutral-700 {
@media (prefers-color-scheme: dark) {
border-color: var(--color-neutral-700);
}
}
.dark\:bg-neutral-800 {
@media (prefers-color-scheme: dark) {
background-color: var(--color-neutral-800);
}
}
.dark\:bg-neutral-900 { .dark\:bg-neutral-900 {
@media (prefers-color-scheme: dark) { @media (prefers-color-scheme: dark) {
background-color: var(--color-neutral-900); background-color: var(--color-neutral-900);
} }
} }
.dark\:bg-neutral-900\/80 {
@media (prefers-color-scheme: dark) {
background-color: color-mix(in srgb, oklch(20.5% 0 0) 80%, transparent);
@supports (color: color-mix(in lab, red, red)) {
background-color: color-mix(in oklab, var(--color-neutral-900) 80%, transparent);
}
}
}
.dark\:bg-zinc-800\/50 { .dark\:bg-zinc-800\/50 {
@media (prefers-color-scheme: dark) { @media (prefers-color-scheme: dark) {
background-color: color-mix(in srgb, oklch(27.4% 0.006 286.033) 50%, transparent); background-color: color-mix(in srgb, oklch(27.4% 0.006 286.033) 50%, transparent);
@ -3240,6 +3287,31 @@
--tw-gradient-stops: var(--tw-gradient-via-stops, var(--tw-gradient-position), var(--tw-gradient-from) var(--tw-gradient-from-position), var(--tw-gradient-to) var(--tw-gradient-to-position)); --tw-gradient-stops: var(--tw-gradient-via-stops, var(--tw-gradient-position), var(--tw-gradient-from) var(--tw-gradient-from-position), var(--tw-gradient-to) var(--tw-gradient-to-position));
} }
} }
.dark\:text-gray-400 {
@media (prefers-color-scheme: dark) {
color: var(--color-gray-400);
}
}
.dark\:text-neutral-300 {
@media (prefers-color-scheme: dark) {
color: var(--color-neutral-300);
}
}
.dark\:text-neutral-600 {
@media (prefers-color-scheme: dark) {
color: var(--color-neutral-600);
}
}
.dark\:text-pink-300 {
@media (prefers-color-scheme: dark) {
color: var(--color-pink-300);
}
}
.dark\:text-violet-400 {
@media (prefers-color-scheme: dark) {
color: var(--color-violet-400);
}
}
.dark\:text-white { .dark\:text-white {
@media (prefers-color-scheme: dark) { @media (prefers-color-scheme: dark) {
color: var(--color-white); color: var(--color-white);