diff --git a/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html b/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html index a8c293a..f972d36 100644 --- a/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html +++ b/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html @@ -15,4 +15,172 @@
Parameters

This function has no parameters.

hilbish.messages.unreadCount()

Parameters -

This function has no parameters.

Want to help improve this page? Create an issue.

\ No newline at end of file +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete() +

Parameters +

This function has no parameters.

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete() +

Parameters +

This function has no parameters.

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number
r

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message
e

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number
r

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message
e

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number
r

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message
e

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number
r

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message
e

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number
r

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message
e

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number
r

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message
e

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete(idx) +

Deletes the message at idx.

Parameters +

idx number

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

hilbish.messages.all() +

Parameters +

This function has no parameters.

hilbish.messages.clear() +

Parameters +

This function has no parameters.

hilbish.messages.delete() +

Deletes the message at idx.

Parameters +

This function has no parameters.

hilbish.messages.read() +

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.readAll() +

Parameters +

This function has no parameters.

hilbish.messages.unreadCount() +

Parameters +

This function has no parameters.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html b/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html index d3375fa..6565f41 100644 --- a/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html +++ b/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html @@ -41,14 +41,11 @@ shell script if fennel eval has an error.

name string

hilbish.runner.add(name, runner)

Adds a runner to the table of available runners. If runner is a table, it must have the run function in it.

Parameters -

name string -runner function

hilbish.runner.get(name) +

name string

runner function|table

hilbish.runner.get(name)

Get a runner by name.

Parameters

name string

hilbish.runner.set(name, runner)

Sets a runner by name. The runner table must have the run function in it.

Parameters -

name string -runner table

hilbish.runner.exec(cmd, runnerName) +

name string

runner table

hilbish.runner.exec(cmd, runnerName)

Executes cmd with a runner. If runnerName isn’t passed, it uses the user’s current runner.

Parameters -

cmd string -runnerName string?

Want to help improve this page? Create an issue.

\ No newline at end of file +

cmd string

runnerName string?

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/document-lua/docs/api/hilbish/index.xml b/versions/document-lua/docs/api/hilbish/index.xml index ace642a..06aa4de 100644 --- a/versions/document-lua/docs/api/hilbish/index.xml +++ b/versions/document-lua/docs/api/hilbish/index.xml @@ -11,7 +11,10 @@ hilbish.messages.read() Parameters This function has no parameters. hilbish.messages.send(message) Sends a message. Parameters message hilbish.message hilbish.messages.readAll() Parameters This function has no parameters. -hilbish.messages.unreadCount() Parameters This function has no parameters.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Introduction 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. +hilbish.messages.unreadCount() Parameters This function has no parameters. +hilbish.messages.all() Parameters This function has no parameters. +hilbish.messages.clear() Parameters This function has no parameters. +hilbish.messages.delete() Parameters This function has no parameters.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Introduction 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. Note that you don’t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.Module hilbish.oshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/ Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version. Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OSModule hilbish.runnerhttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/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. Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code. diff --git a/versions/document-lua/docs/getting-started/index.html b/versions/document-lua/docs/getting-started/index.html index eb5c09d..cd41233 100644 --- a/versions/document-lua/docs/getting-started/index.html +++ b/versions/document-lua/docs/getting-started/index.html @@ -25,8 +25,29 @@ 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.

Hilbish’s sample configuration is usually located in hilbish.dataDir .. '/.hilbishrc.lua'. You can print that path via Lua to see what it is: print(hilbish.dataDir .. '/.hilbishrc.lua'). As an example, it will usually will result in /usr/share/hilbish/.hilbishrc.lua on Linux.

To edit your user configuration, you can copy that file to hilbish.userDir.config .. '/hilbish/init.lua', -which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.

As the directory is usually ~/.config on Linux, you can run this command to copy it:
cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua

Now you can get to editing it. Since it’s just a Lua file, having basic -knowledge of Lua would help. All of Lua’s standard libraries and functions -from Lua 5.4 are available. Hilbish has some custom and modules that are -available. To see them, you can run the doc command. This also works as -general documentation for other things.

Want to help improve this page? Create an issue.

\ No newline at end of file +which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.

As the directory is usually ~/.config on Linux, you can run this command to copy it:
cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua

Now we can get to customization!

If we closely examine a small snippet of the default config:

 1-- Default Hilbish config
+ 2-- .. with some omitted code .. --
+ 3
+ 4local function doPrompt(fail)
+ 5	hilbish.prompt(lunacolors.format(
+ 6		'{blue}%u {cyan}%d ' .. (fail and '{red}' or '{green}') .. '∆ '
+ 7	))
+ 8end
+ 9
+10doPrompt()
+11
+12bait.catch('command.exit', function(code)
+13	doPrompt(code ~= 0)
+14end)
+

We see a whopping three Hilbish libraries being used in this part of code. +First is of course, named after the shell itself, hilbish +. This is kind of a +“catch-all” namespace for functions that directly related to shell functionality/settings.

And as we can see, the hilbish.prompt +function is used +to change our prompt. Change our prompt to what, exactly?

The doc for the function states that the verbs %u and %dare used for username and current directory +of the shell, respectively.

We wrap this in the lunacolors.format +function, to give +our prompt some nice color.

But you might have also noticed that this is in the doPrompt function, which is called once, +and then used again in a bait +hook. Specifically, the command.exit hook, +which is called after a command exits, so when it finishes running.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/document-lua/index.xml b/versions/document-lua/index.xml index a41922d..f95d066 100644 --- a/versions/document-lua/index.xml +++ b/versions/document-lua/index.xml @@ -68,7 +68,10 @@ hilbish.messages.read() Parameters This function has no parameters. hilbish.messages.send(message) Sends a message. Parameters message hilbish.message hilbish.messages.readAll() Parameters This function has no parameters. -hilbish.messages.unreadCount() Parameters This function has no parameters.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Introduction 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. +hilbish.messages.unreadCount() Parameters This function has no parameters. +hilbish.messages.all() Parameters This function has no parameters. +hilbish.messages.clear() Parameters This function has no parameters. +hilbish.messages.delete() Parameters This function has no parameters.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/Introduction 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. Note that you don’t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.Module hilbish.oshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/ Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version. Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OSModule hilbish.runnerhttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/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. Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.