diff --git a/docs/api/bait/index.html b/docs/api/bait/index.html index 606a6e0..e1623b7 100644 --- a/docs/api/bait/index.html +++ b/docs/api/bait/index.html @@ -1,7 +1,7 @@ Module bait — Hilbish

Module bait

the event emitter

Introduction +

Module bait

the event emitter

Introduction

Bait is the event emitter for Hilbish. Why name it bait? Why not. It throws hooks that you can catch. This is what you will use if you want to listen in on hooks to know when certain things have diff --git a/docs/api/commander/index.html b/docs/api/commander/index.html index f648490..ee2ffc5 100644 --- a/docs/api/commander/index.html +++ b/docs/api/commander/index.html @@ -1,7 +1,7 @@ Module commander — Hilbish

Module commander

library for custom commands

Introduction +

Module commander

library for custom commands

Introduction

Commander is a library for writing custom commands in Lua. In order to make it easier to write commands for Hilbish, not require separate scripts and to be able to use in a config, diff --git a/docs/api/fs/index.html b/docs/api/fs/index.html index 78fb16f..f828ef2 100644 --- a/docs/api/fs/index.html +++ b/docs/api/fs/index.html @@ -1,7 +1,7 @@ Module fs — Hilbish

Module fs

filesystem interaction and functionality library

Introduction +

Module fs

filesystem interaction and functionality library

Introduction

The fs module provides easy and simple access to filesystem functions and other things, and acts an addition to the Lua standard library’s I/O and filesystem functions.

Functions diff --git a/docs/api/hilbish/hilbish.aliases/index.html b/docs/api/hilbish/hilbish.aliases/index.html index 901f14e..bcb4434 100644 --- a/docs/api/hilbish/hilbish.aliases/index.html +++ b/docs/api/hilbish/hilbish.aliases/index.html @@ -1,7 +1,7 @@ Interface hilbish.aliases — Hilbish

Interface hilbish.aliases

command aliasing

Introduction +

Interface hilbish.aliases

command aliasing

Introduction

The alias interface deals with all command aliases in Hilbish.

Functions

add(alias, cmd)

This is an alias (ha) for the hilbish.alias function.

delete(name) diff --git a/docs/api/hilbish/hilbish.completions/index.html b/docs/api/hilbish/hilbish.completions/index.html index c05568a..fb16b88 100644 --- a/docs/api/hilbish/hilbish.completions/index.html +++ b/docs/api/hilbish/hilbish.completions/index.html @@ -1,7 +1,7 @@ Interface hilbish.completions — Hilbish

Interface hilbish.completions

tab completions

Introduction +

Interface hilbish.completions

tab completions

Introduction

The completions interface deals with tab completions.

Functions

call(name, query, ctx, fields) -> completionGroups (table), prefix (string)

Calls a completer function. This is mainly used to call diff --git a/docs/api/hilbish/hilbish.editor/index.html b/docs/api/hilbish/hilbish.editor/index.html index 9421b72..0200b83 100644 --- a/docs/api/hilbish/hilbish.editor/index.html +++ b/docs/api/hilbish/hilbish.editor/index.html @@ -1,7 +1,7 @@ Interface hilbish.editor — Hilbish

Interface hilbish.editor

interactions for Hilbish's line reader

Introduction +

Interface hilbish.editor

interactions for Hilbish's line reader

Introduction

The hilbish.editor interface provides functions to directly interact with the line editor in use.

Functions

getLine() -> string diff --git a/docs/api/hilbish/hilbish.history/index.html b/docs/api/hilbish/hilbish.history/index.html index 82330d3..380b819 100644 --- a/docs/api/hilbish/hilbish.history/index.html +++ b/docs/api/hilbish/hilbish.history/index.html @@ -1,7 +1,7 @@ Interface hilbish.history — Hilbish

Interface hilbish.history

command history

Introduction +

Interface hilbish.history

command history

Introduction

The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.

Functions diff --git a/docs/api/hilbish/hilbish.jobs/index.html b/docs/api/hilbish/hilbish.jobs/index.html index 9a1c956..d4e5cae 100644 --- a/docs/api/hilbish/hilbish.jobs/index.html +++ b/docs/api/hilbish/hilbish.jobs/index.html @@ -1,7 +1,7 @@ Interface hilbish.jobs — Hilbish

Interface hilbish.jobs

background job management

Introduction +

Interface hilbish.jobs

background job management

Introduction

Manage interactive jobs in Hilbish via Lua.

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.

Functions

add(cmdstr, args, execPath) diff --git a/docs/api/hilbish/hilbish.os/index.html b/docs/api/hilbish/hilbish.os/index.html index f619bbe..6d344be 100644 --- a/docs/api/hilbish/hilbish.os/index.html +++ b/docs/api/hilbish/hilbish.os/index.html @@ -1,7 +1,7 @@ Interface hilbish.os — Hilbish

Interface hilbish.os

OS Info

Introduction +

Interface hilbish.os

OS Info

Introduction

The os interface provides simple text information properties about the current OS on the systen. This mainly includes the name and version.

Interface fields diff --git a/docs/api/hilbish/hilbish.runner/index.html b/docs/api/hilbish/hilbish.runner/index.html index 91042d1..e220e12 100644 --- a/docs/api/hilbish/hilbish.runner/index.html +++ b/docs/api/hilbish/hilbish.runner/index.html @@ -1,7 +1,7 @@ Interface hilbish.runner — Hilbish

Interface hilbish.runner

interactive command runner customization

Introduction +

Interface hilbish.runner

interactive command runner customization

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 diff --git a/docs/api/hilbish/hilbish.timers/index.html b/docs/api/hilbish/hilbish.timers/index.html index 5b127dc..487ff5e 100644 --- a/docs/api/hilbish/hilbish.timers/index.html +++ b/docs/api/hilbish/hilbish.timers/index.html @@ -1,7 +1,7 @@ Interface hilbish.timers — Hilbish

Interface hilbish.timers

timeout and interval API

Introduction +

Interface hilbish.timers

timeout and interval API

Introduction

If you ever want to run a piece of code on a timed interval, or want to wait a few seconds, you don’t have to rely on timing tricks, as Hilbish has a timer API to set intervals and timeouts.

These are the simple functions hilbish.interval and hilbish.timeout (doc diff --git a/docs/api/hilbish/hilbish.userdir/index.html b/docs/api/hilbish/hilbish.userdir/index.html index 309be21..54ad4e3 100644 --- a/docs/api/hilbish/hilbish.userdir/index.html +++ b/docs/api/hilbish/hilbish.userdir/index.html @@ -1,7 +1,7 @@ Interface hilbish.userDir — Hilbish

Interface hilbish.userDir

user-related directories

Introduction +

Interface hilbish.userDir

user-related directories

Introduction

This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user’s preferred directories for configs and data.

Interface fields diff --git a/docs/api/hilbish/index.html b/docs/api/hilbish/index.html index b43bbd9..aa4a0e2 100644 --- a/docs/api/hilbish/index.html +++ b/docs/api/hilbish/index.html @@ -1,7 +1,7 @@ Module hilbish — Hilbish

Module hilbish

the core Hilbish API

Introduction +

Module hilbish

the core Hilbish API

Introduction

The Hilbish module includes the core API, containing interfaces and functions which directly relate to shell functionality.

Interface fields

  • ver: The version of Hilbish
  • user: Username of the user
  • host: Hostname of the machine
  • dataDir: Directory for Hilbish data files, including the docs and default modules
  • interactive: Is Hilbish in an interactive shell?
  • login: Is Hilbish the login shell?
  • vimMode: Current Vim input mode of Hilbish (will be nil if not in Vim input mode)
  • exitCode: xit code of the last executed command

Functions diff --git a/docs/api/index.html b/docs/api/index.html index 23f2ef9..14ea505 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -1,5 +1,5 @@ API — Hilbish

API

Welcome to the API documentation for Hilbish. This documents Lua functions +

API

Welcome to the API documentation for Hilbish. This documents Lua functions provided by Hilbish.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/terminal/index.html b/docs/api/terminal/index.html index c0169e1..9823a05 100644 --- a/docs/api/terminal/index.html +++ b/docs/api/terminal/index.html @@ -1,7 +1,7 @@ Module terminal — Hilbish

Module terminal

low level terminal library

Introduction +

Module terminal

low level terminal library

Introduction

The terminal library is a simple and lower level library for certain terminal interactions.

Functions

restoreState()

Restores the last saved state of the terminal

saveState() diff --git a/docs/faq/index.html b/docs/faq/index.html index 8486062..5c7f65c 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -5,7 +5,7 @@ Windows Support? It compiles for Windows (CI ensures it does), but otherwise it Where is the API documentation?" name=description>

Frequently Asked Questions

Last updated Dec 20, 2022

Is Hilbish POSIX compliant? +

Frequently Asked Questions

Last updated Dec 20, 2022

Is Hilbish POSIX compliant?

No, it is not. POSIX compliance is a non-goal. Perhaps in the future, someone would be able to write a native plugin to support shell scripting (which would be against it’s main goal, but ….)

Windows Support? diff --git a/docs/features/index.html b/docs/features/index.html index 0a5d131..da77265 100644 --- a/docs/features/index.html +++ b/docs/features/index.html @@ -1,7 +1,7 @@ Features — Hilbish

Features

Last updated Apr 14, 2023

Hilbish has a wide range of features to enhance the user’s experience +

Features

Last updated Apr 14, 2023

Hilbish has a wide range of features to enhance the user’s experience new ones are always being added. If there is something missing here or something you would like to see, please start a discussion or comment on any existing ones which match your request.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/features/index.xml b/docs/features/index.xml index fdaa448..2e86b3a 100644 --- a/docs/features/index.xml +++ b/docs/features/index.xml @@ -1,2 +1,4 @@ -Features on Hilbishhttps://rosettea.github.io/Hilbish/docs/features/Recent content in Features on HilbishHugo -- gohugo.ioen-usRunner Modehttps://rosettea.github.io/Hilbish/docs/features/runner-mode/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/features/runner-mode/Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script. +Features on Hilbishhttps://rosettea.github.io/Hilbish/docs/features/Recent content in Features on HilbishHugo -- gohugo.ioen-usNotificationhttps://rosettea.github.io/Hilbish/docs/features/notifications/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/features/notifications/Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface. +A message is defined as a table with the following properties: +icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.Runner Modehttps://rosettea.github.io/Hilbish/docs/features/runner-mode/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/features/runner-mode/Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script. In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages, instead of either like Fennel. \ No newline at end of file diff --git a/docs/features/notifications/index.html b/docs/features/notifications/index.html new file mode 100644 index 0000000..9794718 --- /dev/null +++ b/docs/features/notifications/index.html @@ -0,0 +1,15 @@ +Notification — Hilbish +

Notification

Last updated Jul 10, 2023
Get notified of shell actions.

Hilbish features a simple notification system which can be +used by other plugins and parts of the shell to notify the user +of various actions. This is used via the hilbish.message interface.

A message is defined as a table with the following properties:

  • icon: A unicode/emoji icon for the notification.
  • title: The title of the message
  • text: Message text/body
  • channel: The source of the message. This should be a +unique and easily readable text identifier.
  • summary: A short summary of the notification and message. +If this is not present and you are using this to display messages, +you should take part of the text instead.

The hilbish.message interface provides the following functions:

  • send(message): Sends a message and emits the hilbish.notification +signal. DO NOT emit the hilbish.notification signal directly, or +the message will not be stored by the message handler.
  • read(idx): Marks message at idx as read.
  • delete(idx): Removes message at idx.
  • readAll(): Marks all messages as read.
  • clear(): Deletes all messages.

There are a few simple use cases of this notification/messaging system. +It could also be used as some “inter-shell” messaging system (???) but +is intended to display to users.

An example is notifying users of completed jobs/commands ran in the background. +Any Hilbish-native command (think the upcoming Greenhouse pager) can display +it.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/features/runner-mode/index.html b/docs/features/runner-mode/index.html index 857ae79..cfed004 100644 --- a/docs/features/runner-mode/index.html +++ b/docs/features/runner-mode/index.html @@ -1,7 +1,7 @@ Runner Mode — Hilbish

Runner Mode

Last updated Apr 14, 2023
Customize the interactive script/command runner.

Hilbish allows you to change how interactive text can be interpreted. +

Runner Mode

Last updated Apr 14, 2023
Customize the interactive script/command runner.

Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.

In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 245c213..b663bb2 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -3,7 +3,7 @@ Setting as Default Login shell There are a few ways to make Hilbish your default Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell." name=description>

Getting Started

Last updated Apr 14, 2023

To start Hilbish, open a terminal. If Hilbish has been installed and is not the +

Getting Started

Last updated Apr 14, 2023

To start Hilbish, open a terminal. If Hilbish has been installed and is not the default shell, you can simply run hilbish to start it. This will launch a normal interactive session. To exit, you can either run the exit command or hit Ctrl+D.

Setting as Default diff --git a/docs/index.html b/docs/index.html index c73e23e..80d6d54 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,7 +3,7 @@ Here documents some of the features of Hilbish and the Lua API." property="og:de Here documents some of the features of Hilbish and the Lua API." name=description>

Introduction

Last updated Dec 20, 2022

Hilbish is a hyper-extensible shell mainly intended for interactive use. +

Introduction

Last updated Dec 20, 2022

Hilbish is a hyper-extensible shell mainly intended for interactive use. To enhance the interactive experience, Hilbish comes with a wide range of features and sane defaults, including a nice looking prompt, advanced completion menus and history search.

Here documents some of the features of Hilbish and the Lua API.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/index.xml b/index.xml index 4b4a14b..c2e0397 100644 --- a/index.xml +++ b/index.xml @@ -47,5 +47,7 @@ dir(path) -> string Returns the directory part of path. For the rules, se Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal setRaw() Puts the terminal in raw mode -size() Gets the dimensions of the terminal. Returns a table with width and height Note: this is not the size in relation to the dimensions of the displayRunner Modehttps://rosettea.github.io/Hilbish/docs/features/runner-mode/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/features/runner-mode/Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script. +size() Gets the dimensions of the terminal. Returns a table with width and height Note: this is not the size in relation to the dimensions of the displayNotificationhttps://rosettea.github.io/Hilbish/docs/features/notifications/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/features/notifications/Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface. +A message is defined as a table with the following properties: +icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.Runner Modehttps://rosettea.github.io/Hilbish/docs/features/runner-mode/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/features/runner-mode/Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script. In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages, instead of either like Fennel.Welcome to the Hilbish bloghttps://rosettea.github.io/Hilbish/blog/welcome/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/blog/welcome/Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development). \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index c7a5a43..e5edde4 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://rosettea.github.io/Hilbish/docs/api/https://rosettea.github.io/Hilbish/docs/features/2023-04-14T00:24:19-04:00https://rosettea.github.io/Hilbish/docs/faq/2022-12-20T00:41:48-04:00https://rosettea.github.io/Hilbish/docs/getting-started/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/docs/2022-12-20T19:42:44-04:00https://rosettea.github.io/Hilbish/blog/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/blog/improving-this-website/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/blog/v2.1.2-release/2023-04-10T12:38:30-04:00https://rosettea.github.io/Hilbish/blog/v2.1.1-release/2023-04-01T18:16:13-04:00https://rosettea.github.io/Hilbish/blog/v2.1-release/2023-02-10T17:11:44-04:00https://rosettea.github.io/Hilbish/blog/v2.0-release/2022-12-28T22:27:05-04:00https://rosettea.github.io/Hilbish/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/categories/https://rosettea.github.io/Hilbish/install/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.aliases/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.completions/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.editor/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.history/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.jobs/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.os/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.runner/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.timers/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.userdir/https://rosettea.github.io/Hilbish/docs/api/bait/https://rosettea.github.io/Hilbish/docs/api/commander/https://rosettea.github.io/Hilbish/docs/api/fs/https://rosettea.github.io/Hilbish/docs/api/hilbish/https://rosettea.github.io/Hilbish/docs/api/terminal/https://rosettea.github.io/Hilbish/docs/features/runner-mode/2023-04-14T00:40:41-04:00https://rosettea.github.io/Hilbish/tags/https://rosettea.github.io/Hilbish/blog/welcome/2022-12-28T22:27:05-04:00 \ No newline at end of file +https://rosettea.github.io/Hilbish/docs/api/https://rosettea.github.io/Hilbish/docs/features/2023-04-14T00:24:19-04:00https://rosettea.github.io/Hilbish/docs/faq/2022-12-20T00:41:48-04:00https://rosettea.github.io/Hilbish/docs/getting-started/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/docs/2022-12-20T19:42:44-04:00https://rosettea.github.io/Hilbish/blog/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/blog/improving-this-website/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/blog/v2.1.2-release/2023-04-10T12:38:30-04:00https://rosettea.github.io/Hilbish/blog/v2.1.1-release/2023-04-01T18:16:13-04:00https://rosettea.github.io/Hilbish/blog/v2.1-release/2023-02-10T17:11:44-04:00https://rosettea.github.io/Hilbish/blog/v2.0-release/2022-12-28T22:27:05-04:00https://rosettea.github.io/Hilbish/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/categories/https://rosettea.github.io/Hilbish/install/2023-04-14T00:04:52-04:00https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.aliases/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.completions/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.editor/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.history/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.jobs/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.os/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.runner/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.timers/https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.userdir/https://rosettea.github.io/Hilbish/docs/api/bait/https://rosettea.github.io/Hilbish/docs/api/commander/https://rosettea.github.io/Hilbish/docs/api/fs/https://rosettea.github.io/Hilbish/docs/api/hilbish/https://rosettea.github.io/Hilbish/docs/api/terminal/https://rosettea.github.io/Hilbish/docs/features/notifications/2023-07-10T19:03:30-04:00https://rosettea.github.io/Hilbish/docs/features/runner-mode/2023-04-14T00:40:41-04:00https://rosettea.github.io/Hilbish/tags/https://rosettea.github.io/Hilbish/blog/welcome/2022-12-28T22:27:05-04:00 \ No newline at end of file