mirror of
https://github.com/Hilbis/Hilbish
synced 2025-06-08 05:22:02 +00:00
48 lines
7.7 KiB
HTML
48 lines
7.7 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="/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-|||-|----|----|-|<a-href="aliases.add">add(alias-cmd)</a>|This-is-an-alias-(ha)-for-the-hilbish.alias-function.|-|<a-href="aliases.delete">delete(name)</a>|Removes-an-alias.|-|<a-href="aliases.list">list()-->-table[string-string]</a>|Get-a-table-of-all-aliases-with-string-keys-as-the-alias-and-the-value-as-the-command.|-|<a-href="aliases.resolve">resolve(alias)-->-string</a>|Resolves-an-alias-to-its-original-command.-Will-thrown-an-error-if-the-alias-doesn't-exist.|">Functions
|
|
|||
|
|
|----|----|
|
|
|<a href="#aliases.add">add(alias, cmd)</a>|This is an alias (ha) for the <a href="../#alias">hilbish.alias</a> function.|
|
|
|<a href="#aliases.delete">delete(name)</a>|Removes an alias.|
|
|
|<a href="#aliases.list">list() -> table[string, string]</a>|Get a table of all aliases, with string keys as the alias and the value as the command.|
|
|
|<a href="#aliases.resolve">resolve(alias) -> string?</a>|Resolves an alias to its original command. Will thrown an error if the alias doesn't exist.|</h2><p><hr>
|
|
<div id='aliases.add'>
|
|
<h4 class='heading'>
|
|
hilbish.aliases.add(alias, cmd)
|
|
<a href="#aliases.add" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></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.---</div>">Parameters
|
|
This function has no parameters.
|
|
</div></p><p><hr>
|
|
<div id='aliases.delete'>
|
|
<h4 class='heading'>
|
|
hilbish.aliases.delete(name)
|
|
<a href="#aliases.delete" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></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></div></p><p><hr>
|
|
<div id='aliases.list'>
|
|
<h4 class='heading'>
|
|
hilbish.aliases.list() -> table[string, string]
|
|
<a href="#aliases.list" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></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('hi'-'echo-hi')">Parameters
|
|
This function has no parameters.
|
|
Example
|
|
<code>lua
|
|
hilbish.aliases.add('hi', 'echo hi')</code></p><p>local aliases = hilbish.aliases.list()
|
|
-- -> {hi = 'echo hi'}
|
|
<code>
|
|
</div></code></p><p><hr>
|
|
<div id='aliases.resolve'>
|
|
<h4 class='heading'>
|
|
hilbish.aliases.resolve(alias) -> string?
|
|
<a href="#aliases.resolve" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Resolves an alias to its original command. Will thrown an error if the alias doesn't exist. </p><p class="font-bold text-xl" id="Parameters-string-**alias**">Parameters
|
|
<code>string</code> **<code>alias</code>** </p><p></div></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> |