mirror of
https://github.com/Hilbis/Hilbish
synced 2025-07-01 08:42:04 +00:00
41 lines
13 KiB
HTML
41 lines
13 KiB
HTML
<!doctype html>
|
|
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="https://rosettea.github.io/Hilbish/versions/new-website/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name="description"><meta content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content="https://rosettea.github.io/Hilbish/versions/new-website" property="og:url"></head><body class="h-screen flex flex-col"><nav class="bg-stone-100/80 dark:bg-neutral-950/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="https://rosettea.github.io/Hilbish/versions/new-website/"><img class="h-8" src="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3"><a href="https://rosettea.github.io/Hilbish/versions/new-website/install"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Install</span></a><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Docs</span></a><a href="https://rosettea.github.io/Hilbish/versions/new-website/blog"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Blog</span></a></div></nav><div class="flex-1 flex flex-col overflow-hidden"><div class="sm:hidden h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-white"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span class="font-bold">Getting Started</span></div><div class="flex-1 sm:flex grid overflow-hidden"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="overflow-y-scroll p-4 sm:border-r sm:border-r-zinc-300 col-start-1 row-start-1 bg-neutral-100 dark:bg-neutral-950 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul class="text-lg flex flex-col gap-2"><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs">Introduction</a></li><li class="font-bold text-pink-400"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/getting-started"> -> Getting Started</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/faq">Frequently Asked Questions</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features">Features</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/completions">Completions</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/opts">Options</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/runner-mode">Runner Mode</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks">Signals</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/command">Command</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/signal">Signal</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/lunacolors">Lunacolors</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api">API</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/readline">Module readline</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/yarn">Module yarn</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature">Nature</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature/doc">Module doc</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/vim-mode">Vim Mode</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/vim-mode/actions">Actions</a></li></ul></ul></div><main class="flex-1 flex justify-center basis-7/7 col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30"><div class="flex-1 flex flex-col overflow-y-auto"><div class="flex-1 w-3/4 self-center p-8"><h1 class="my-3 font-bold text-4xl">Getting Started</h1><i></i><p>To start Hilbish, open a terminal. If Hilbish has been installed and is not the
|
|
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.
|
|
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="my-4 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Setting-as-Default">Setting as Default</h1><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Login-shell">Login shell</h2><p>There are a few ways to make Hilbish your default shell. A simple way is
|
|
to make it your user/login shell.</p><p>{{< 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
|
|
you still decide to do it, there will just be a few variables missing in
|
|
your environment</code> >}}</p><p>To do that, simply run <code class="text-violet-600 dark:text-violet-400">chsh -s /usr/bin/hilbish</code>.</p><p>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 <user></code>.
|
|
When prompted, you can put the path for Hilbish.</p><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Default-with-terminal">Default with terminal</h2><p>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.</p><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Run-after-login-shell">Run after login shell</h2><p>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 with this command: <code class="text-violet-600 dark:text-violet-400">exec hilbish -S -l</code></p><p>This will replace the shell with Hilbish, set $SHELL to Hilbish and launch it as a login shell.</p><h1 class="my-4 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Configuration">Configuration</h1><p>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.<br> <br>Hilbish's sample configuration is usually located in <code class="text-violet-600 dark:text-violet-400">hilbish.dataDir .. '/.hilbishrc.lua'</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 .. '/.hilbishrc.lua')</code>.<br> <br>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.<br> <br>To edit your user configuration, you can copy that file to <code class="text-violet-600 dark:text-violet-400">hilbish.userDir.config .. '/hilbish/init.lua'</code>, which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.<br> <br>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 class="text-violet-600 dark:text-violet-400">cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code>. Now we can get to customization!<br> <br>If we closely examine a small snippet of the default config:</p><pre><code data-lang="lua">-- Default Hilbish config
|
|
-- .. with some omitted code .. --
|
|
|
|
local function doPrompt(fail)
|
|
hilbish.prompt(lunacolors.format(
|
|
'{blue}%u {cyan}%d ' .. (fail and '{red}' or '{green}') .. '∆ '
|
|
))
|
|
end
|
|
|
|
doPrompt()
|
|
|
|
bait.catch('command.exit', function(code)
|
|
doPrompt(code ~= 0)
|
|
end)
|
|
</code></pre><p><br>
|
|
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 class="text-violet-600 dark:text-violet-400">hilbish</code></a>. This is kind of a
|
|
"catch-all" namespace for functions that directly related to shell functionality/settings.<br> <br>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?<br>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.<br>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.<br> <br>
|
|
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 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></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="https://rosettea.github.io/Hilbish/versions/new-website"><img class="h-24" src="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish" target="_blank"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline"><tag><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6">
|
|
<path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25" />
|
|
</svg>
|
|
</tag>GitHub</span></a></div></footer></div></main></div></div></body></html> |