mirror of
https://github.com/Hilbis/Hilbish
synced 2025-05-06 04:13:24 +00:00
158 lines
8.6 KiB
HTML
158 lines
8.6 KiB
HTML
<!doctype html>
|
|
<html class="bg-stone-50 dark:bg-neutral-950 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="https://rosettea.github.io/Hilbish/versions/new-website" property="og:url"></head><body><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="block sm:hidden h-10 sticky top-12 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/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 sm:flex"><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 basis-3/5 transition-transform duration-300 -translate-x-full sm:translate-x-0 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">Lunacolors</li><li class="mb-2">Introduction</li><li class="mb-2">Completions</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Options</li><li class="mb-2">Features</li><li class="mb-2">Runner Mode</li><li class="mb-2">Notification</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Command</li><li class="mb-2">Hilbish</li><li class="mb-2">Vim Mode</li><li class="mb-2">Actions</li><li class="mb-2">Module bait</li><li class="mb-2">Module terminal</li><li class="mb-2">API</li><li class="mb-2">Module fs</li><li class="mb-2">Module commander</li><li class="mb-2">Module snail</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module dirs</li><li class="mb-2">Nature</li><li class="mb-2">Module doc</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>Module hilbish.jobs</h1><Tag xmlns="namespace"><h2>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>Functions</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th></th>
|
|
<th></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a href="#jobs.add" rel="noopener noreferrer">add(cmdstr, args, execPath)</a></td>
|
|
<td>Creates a new job. This function does not run the job. This function is intended to be</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#jobs.all" rel="noopener noreferrer">all() -> table[@Job]</a></td>
|
|
<td>Returns a table of all job objects.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#jobs.disown" rel="noopener noreferrer">disown(id)</a></td>
|
|
<td>Disowns a job. This simply deletes it from the list of jobs without stopping it.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#jobs.get" rel="noopener noreferrer">get(id) -> @Job</a></td>
|
|
<td>Get a job object via its ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="#jobs.last" rel="noopener noreferrer">last() -> @Job</a></td>
|
|
<td>Returns the last added job to the table.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr>
|
|
<div>
|
|
<h4>
|
|
hilbish.jobs.add(cmdstr, args, execPath)
|
|
<a href="#jobs.add" rel="noopener noreferrer">
|
|
<i></i>
|
|
</a>
|
|
</h4>
|
|
<p>Creates a new job. This function does not run the job. This function is intended to be<br>
|
|
used by runners, but can also be used to create jobs via Lua. Commanders cannot be ran as jobs.</p>
|
|
<h4>Parameters</h4>
|
|
<p><code>string</code> <strong><code>cmdstr</code></strong><br>
|
|
String that a user would write for the job</p>
|
|
<p><code>table</code> <strong><code>args</code></strong><br>
|
|
Arguments for the commands. Has to include the name of the command.</p>
|
|
<p><code>string</code> <strong><code>execPath</code></strong><br>
|
|
Binary to use to run the command. Needs to be an absolute path.</p>
|
|
<h4>Example</h4>
|
|
<pre><code><span><span>hilbish</span><span>.</span><span>jobs</span><span>.</span><span>add</span><span>(</span><span>'go build'</span><span>,</span> <span>{</span><span>'go'</span><span>,</span> <span>'build'</span><span>}</span><span>,</span> <span>'/usr/bin/go'</span><span>)</span>
|
|
</span></code></pre>
|
|
</div>
|
|
<hr>
|
|
<div>
|
|
<h4>
|
|
hilbish.jobs.all() -> table[<a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" rel="noopener noreferrer">Job</a>]
|
|
<a href="#jobs.all" rel="noopener noreferrer">
|
|
<i></i>
|
|
</a>
|
|
</h4>
|
|
<p>Returns a table of all job objects.</p>
|
|
<h4>Parameters</h4>
|
|
<p>This function has no parameters.</p>
|
|
</div>
|
|
<hr>
|
|
<div>
|
|
<h4>
|
|
hilbish.jobs.disown(id)
|
|
<a href="#jobs.disown" rel="noopener noreferrer">
|
|
<i></i>
|
|
</a>
|
|
</h4>
|
|
<p>Disowns a job. This simply deletes it from the list of jobs without stopping it.</p>
|
|
<h4>Parameters</h4>
|
|
<p><code>number</code> <strong><code>id</code></strong></p>
|
|
</div>
|
|
<hr>
|
|
<div>
|
|
<h4>
|
|
hilbish.jobs.get(id) -> <a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" rel="noopener noreferrer">Job</a>
|
|
<a href="#jobs.get" rel="noopener noreferrer">
|
|
<i></i>
|
|
</a>
|
|
</h4>
|
|
<p>Get a job object via its ID.</p>
|
|
<h4>Parameters</h4>
|
|
<p>This function has no parameters.</p>
|
|
</div>
|
|
<hr>
|
|
<div>
|
|
<h4>
|
|
hilbish.jobs.last() -> <a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" rel="noopener noreferrer">Job</a>
|
|
<a href="#jobs.last" rel="noopener noreferrer">
|
|
<i></i>
|
|
</a>
|
|
</h4>
|
|
<p>Returns the last added job to the table.</p>
|
|
<h4>Parameters</h4>
|
|
<p>This function has no parameters.</p>
|
|
</div>
|
|
<h2>Types</h2>
|
|
<hr>
|
|
<h2>Job</h2>
|
|
<p>The Job type describes a Hilbish job.</p>
|
|
<h2>Object properties</h2>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th></th>
|
|
<th></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>cmd</td>
|
|
<td>The user entered command string for the job.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>running</td>
|
|
<td>Whether the job is running or not.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>id</td>
|
|
<td>The ID of the job in the job table</td>
|
|
</tr>
|
|
<tr>
|
|
<td>pid</td>
|
|
<td>The Process ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td>exitCode</td>
|
|
<td>The last exit code of the job.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stdout</td>
|
|
<td>The standard output of the job. This just means the normal logs of the process.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>stderr</td>
|
|
<td>The standard error stream of the process. This (usually) includes error messages of the job.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Methods</h3>
|
|
<h4>background()</h4>
|
|
<p>Puts a job in the background. This acts the same as initially running a job.</p>
|
|
<h4>foreground()</h4>
|
|
<p>Puts a job in the foreground. This will cause it to run like it was
|
|
executed normally and wait for it to complete.</p>
|
|
<h4>start()</h4>
|
|
<p>Starts running the job.</p>
|
|
<h4>stop()</h4>
|
|
<p>Stops the job from running.</p></Tag></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> |