mirror of
https://github.com/Hilbis/Hilbish
synced 2025-07-22 18:52:02 +00:00
30 lines
10 KiB
HTML
30 lines
10 KiB
HTML
<!doctype html>
|
|
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="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="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="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 dark:text-pink-300 text-pink-600"><a href="https://rosettea.github.io/Hilbish/versions/new-website//">Home</a><a href="https://rosettea.github.io/Hilbish/versions/new-website///install">Install</a><a href="https://rosettea.github.io/Hilbish/versions/new-website///docs">Docs</a><a href="https://rosettea.github.io/Hilbish/versions/new-website///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's missing one or two things,
|
|
but works well. One thing which is different from other shells
|
|
(besides Hilbish) itself is the API for jobs, and of course it's in Lua.
|
|
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 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're-called-from-hilbish.jobs-so-a-listing-of-foo-would-mean-hilbish.jobs.foo)">Functions
|
|
(Note that in the list here, they're called from <code class="text-violet-600 dark:text-violet-400">hilbish.jobs</code>, so
|
|
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:'-';"><li><p><code class="text-violet-600 dark:text-violet-400">all()</code> -> {jobs}: Returns a table of all jobs.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">last()</code> -> job: Returns the last added job.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">get(id)</code> -> 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> -> 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 class="text-violet-600 dark:text-violet-400">cmdstr</code> is the user'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't set it as entry 0 in the table)
|
|
and <code class="text-violet-600 dark:text-violet-400">execPath</code> is an absolute path for the command executable.
|
|
- <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 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.
|
|
Example: hilbish.jobs.last():foreground()
|
|
Which will foreground the last job.</h1><p>You can still have a job object for a disowned job,
|
|
it just won'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'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 class="text-violet-600 dark:text-violet-400">cmd</code>: command string
|
|
- <code class="text-violet-600 dark:text-violet-400">running</code>: boolean whether the job is running
|
|
- <code class="text-violet-600 dark:text-violet-400">id</code>: unique id for the job
|
|
- <code class="text-violet-600 dark:text-violet-400">pid</code>: process id for the job
|
|
- <code class="text-violet-600 dark:text-violet-400">exitCode</code>: exit code of the job
|
|
In ordinary cases you'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 class="text-violet-600 dark:text-violet-400">id</code> is unique to Hilbish and is how you get jobs with the
|
|
<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 class="text-violet-600 dark:text-violet-400">stop()</code>: Stops the job.
|
|
- <code class="text-violet-600 dark:text-violet-400">start()</code>: Starts the job.
|
|
- <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.
|
|
- <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="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"><span class="text-pink-300 text-light">GitHub</span></a></div></footer></body></html> |