From e8814e4da221fa060fb7bd1fc8a686351c3b2e81 Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Sun, 15 Jun 2025 19:15:45 +0000 Subject: [PATCH] deploy: c71ed0015ffcf4b3746634d1d1ca4cd8ed488d24 --- .../readline-move/docs/api/bait/index.html | 2 +- .../docs/api/commander/index.html | 2 +- versions/readline-move/docs/api/fs/index.html | 2 +- .../docs/api/hilbish/hilbish.abbr/index.html | 2 +- .../api/hilbish/hilbish.aliases/index.html | 2 +- .../api/hilbish/hilbish.completion/index.html | 2 +- .../api/hilbish/hilbish.history/index.html | 2 +- .../docs/api/hilbish/hilbish.jobs/index.html | 2 +- .../api/hilbish/hilbish.messages/index.html | 2 +- .../api/hilbish/hilbish.module/index.html | 2 +- .../docs/api/hilbish/hilbish.os/index.html | 2 +- .../api/hilbish/hilbish.processors/index.html | 2 +- .../api/hilbish/hilbish.runner/index.html | 2 +- .../api/hilbish/hilbish.timers/index.html | 2 +- .../api/hilbish/hilbish.userdir/index.html | 2 +- .../readline-move/docs/api/hilbish/index.html | 2 +- .../readline-move/docs/api/hilbish/index.xml | 3 +- versions/readline-move/docs/api/index.html | 2 +- versions/readline-move/docs/api/index.xml | 5 ++- .../docs/api/readline/index.html | 38 +++++++++---------- .../readline-move/docs/api/snail/index.html | 2 +- .../docs/api/terminal/index.html | 2 +- .../readline-move/docs/completions/index.html | 2 +- versions/readline-move/docs/faq/index.html | 2 +- .../readline-move/docs/features/index.html | 2 +- .../docs/features/notifications/index.html | 2 +- .../docs/features/opts/index.html | 2 +- .../docs/features/runner-mode/index.html | 2 +- .../docs/getting-started/index.html | 2 +- .../docs/hooks/command/index.html | 2 +- .../docs/hooks/hilbish/index.html | 2 +- versions/readline-move/docs/hooks/index.html | 2 +- .../docs/hooks/signal/index.html | 2 +- versions/readline-move/docs/index.html | 2 +- .../readline-move/docs/lunacolors/index.html | 2 +- .../readline-move/docs/nature/dirs/index.html | 2 +- .../readline-move/docs/nature/doc/index.html | 2 +- versions/readline-move/docs/nature/index.html | 2 +- .../docs/vim-mode/actions/index.html | 2 +- .../readline-move/docs/vim-mode/index.html | 2 +- versions/readline-move/index.xml | 8 ++-- versions/readline-move/sitemap.xml | 2 +- 42 files changed, 64 insertions(+), 66 deletions(-) diff --git a/versions/readline-move/docs/api/bait/index.html b/versions/readline-move/docs/api/bait/index.html index b6b48d14..a227ce2a 100644 --- a/versions/readline-move/docs/api/bait/index.html +++ b/versions/readline-move/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. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to diff --git a/versions/readline-move/docs/api/commander/index.html b/versions/readline-move/docs/api/commander/index.html index 5d9d1796..222cb697 100644 --- a/versions/readline-move/docs/api/commander/index.html +++ b/versions/readline-move/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 the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander diff --git a/versions/readline-move/docs/api/fs/index.html b/versions/readline-move/docs/api/fs/index.html index 7c2f9b2c..5d9e2885 100644 --- a/versions/readline-move/docs/api/fs/index.html +++ b/versions/readline-move/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 filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.

Functions diff --git a/versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html b/versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html index ba424c3b..8f6f1654 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.abbr/index.html @@ -1,7 +1,7 @@ Module hilbish.abbr — Hilbish

Module hilbish.abbr

command line abbreviations

Introduction +

Module hilbish.abbr

command line abbreviations

Introduction

The abbr module manages Hilbish abbreviations. These are words that can be replaced with longer command line strings when entered. As an example, git push can be abbreviated to gp. When the user types diff --git a/versions/readline-move/docs/api/hilbish/hilbish.aliases/index.html b/versions/readline-move/docs/api/hilbish/hilbish.aliases/index.html index d421e945..0c087ee4 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.aliases/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.aliases/index.html @@ -1,7 +1,7 @@ Module hilbish.aliases — Hilbish

Module hilbish.aliases

command aliasing

Introduction +

Module 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)Removes an alias.
list() -> table[string, string]Get a table of all aliases, with string keys as the alias and the value as the command.
resolve(alias) -> string?Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist.

hilbish.aliases.add(alias, cmd) diff --git a/versions/readline-move/docs/api/hilbish/hilbish.completion/index.html b/versions/readline-move/docs/api/hilbish/hilbish.completion/index.html index 0a5b698c..331e7289 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.completion/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.completion/index.html @@ -1,7 +1,7 @@ Module hilbish.completion — Hilbish

Module hilbish.completion

tab completions

Introduction +

Module hilbish.completion

tab completions

Introduction

The completions interface deals with tab completions.

Functions

bins(query, ctx, fields) -> entries (table), prefix (string)Return binaries/executables based on the provided parameters.
call(name, query, ctx, fields) -> completionGroups (table), prefix (string)Calls a completer function. This is mainly used to call a command completer, which will have a name
files(query, ctx, fields) -> entries (table), prefix (string)Returns file matches based on the provided parameters.
handler(line, pos)This function contains the general completion handler for Hilbish. This function handles

hilbish.completion.bins(query, ctx, fields) -> entries (table), prefix (string)

Return binaries/executables based on the provided parameters.
This function is meant to be used as a helper in a command completion handler.

Parameters diff --git a/versions/readline-move/docs/api/hilbish/hilbish.history/index.html b/versions/readline-move/docs/api/hilbish/hilbish.history/index.html index 42cde520..6508bafd 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.history/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.history/index.html @@ -1,7 +1,7 @@ Module hilbish.history — Hilbish

Module hilbish.history

command history

Introduction +

Module 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/versions/readline-move/docs/api/hilbish/hilbish.jobs/index.html b/versions/readline-move/docs/api/hilbish/hilbish.jobs/index.html index cb46ed5d..16df36cb 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.jobs/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.jobs/index.html @@ -1,7 +1,7 @@ Module hilbish.jobs — Hilbish

Module hilbish.jobs

background job management

Introduction +

Module 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)Creates a new job. This function does not run the job. This function is intended to be
all() -> table[@Job]Returns a table of all job objects.
disown(id)Disowns a job. This simply deletes it from the list of jobs without stopping it.
get(id) -> @JobGet a job object via its ID.
last() -> @JobReturns the last added job to the table.

hilbish.jobs.add(cmdstr, args, execPath) diff --git a/versions/readline-move/docs/api/hilbish/hilbish.messages/index.html b/versions/readline-move/docs/api/hilbish/hilbish.messages/index.html index e095546d..9352347d 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.messages/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.messages/index.html @@ -1,7 +1,7 @@ Module hilbish.messages — Hilbish

Module hilbish.messages

simplistic message passing

Introduction +

Module hilbish.messages

simplistic message passing

Introduction

The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: diff --git a/versions/readline-move/docs/api/hilbish/hilbish.module/index.html b/versions/readline-move/docs/api/hilbish/hilbish.module/index.html index e8ac42a6..bc0fc9cd 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.module/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.module/index.html @@ -1,7 +1,7 @@ Module hilbish.module — Hilbish

Module hilbish.module

native module loading

Introduction +

Module hilbish.module

native module loading

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 diff --git a/versions/readline-move/docs/api/hilbish/hilbish.os/index.html b/versions/readline-move/docs/api/hilbish/hilbish.os/index.html index db7fad29..3c689782 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.os/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.os/index.html @@ -1,7 +1,7 @@ Module hilbish.os — Hilbish

Module hilbish.os

operating system info

Introduction +

Module hilbish.os

operating system info

Introduction

Provides simple text information properties about the current operating system. This mainly includes the name and version.

Static module fields

familyFamily name of the current OS
namePretty name of the current OS
versionVersion of the current OS

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/readline-move/docs/api/hilbish/hilbish.processors/index.html b/versions/readline-move/docs/api/hilbish/hilbish.processors/index.html index 3bfa8a2d..49c20b5a 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.processors/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.processors/index.html @@ -1,7 +1,7 @@ Module hilbish.processors — Hilbish

Module hilbish.processors

No description.

hilbish.processors.add() +

Module hilbish.processors

No description.

hilbish.processors.add()

Parameters

This function has no parameters.

hilbish.processors.execute()

Run all command processors, in order by priority. diff --git a/versions/readline-move/docs/api/hilbish/hilbish.runner/index.html b/versions/readline-move/docs/api/hilbish/hilbish.runner/index.html index b797f756..e68fda2d 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.runner/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.runner/index.html @@ -1,7 +1,7 @@ Module hilbish.runner — Hilbish

Module hilbish.runner

interactive command runner customization

Introduction +

Module 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/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html b/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html index 6ded1d48..34ece012 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.timers/index.html @@ -1,7 +1,7 @@ Module hilbish.timers — Hilbish

Module hilbish.timers

timeout and interval API

Introduction +

Module 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/versions/readline-move/docs/api/hilbish/hilbish.userdir/index.html b/versions/readline-move/docs/api/hilbish/hilbish.userdir/index.html index fc8a86b3..0220ce6c 100644 --- a/versions/readline-move/docs/api/hilbish/hilbish.userdir/index.html +++ b/versions/readline-move/docs/api/hilbish/hilbish.userdir/index.html @@ -1,7 +1,7 @@ Module hilbish.userDir — Hilbish

Module hilbish.userDir

user-related directories

Introduction +

Module 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.

Static module fields diff --git a/versions/readline-move/docs/api/hilbish/index.html b/versions/readline-move/docs/api/hilbish/index.html index 706880ea..91a9f381 100644 --- a/versions/readline-move/docs/api/hilbish/index.html +++ b/versions/readline-move/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.

Functions

alias(cmd, orig)Sets an alias, with a name of cmd to another command.
appendPath(dir)Appends the provided dir to the command path ($PATH)
complete(scope, cb)Registers a completion handler for the specified scope.
cwd() -> stringReturns the current directory of the shell.
exec(cmd)Replaces the currently running Hilbish instance with the supplied command.
goro(fn)Puts fn in a Goroutine.
highlighter(line)Line highlighter handler.
hinter(line, pos)The command line hint handler. It gets called on every key insert to
inputMode(mode)Sets the input mode for Hilbish’s line reader.
interval(cb, time) -> @TimerRuns the cb function every specified amount of time.
multiprompt(str)Changes the text prompt when Hilbish asks for more input.
prependPath(dir)Prepends dir to $PATH.
prompt(str, typ)Changes the shell prompt to the provided string.
read(prompt) -> input (string)Read input from the user, using Hilbish’s line editor/input reader.
timeout(cb, time) -> @TimerExecuted the cb function after a period of time.
which(name) -> stringChecks if name is a valid command.
runnerMode(mode)Sets the execution/runner mode for interactive Hilbish.
run(cmd, streams)Runs cmd in Hilbish’s shell script interpreter.

Static module fields diff --git a/versions/readline-move/docs/api/hilbish/index.xml b/versions/readline-move/docs/api/hilbish/index.xml index 702513ad..f8fcf714 100644 --- a/versions/readline-move/docs/api/hilbish/index.xml +++ b/versions/readline-move/docs/api/hilbish/index.xml @@ -1,7 +1,6 @@ Module hilbish on Hilbishhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/Recent content in Module hilbish on HilbishHugo -- gohugo.ioen-usModule hilbish.abbrhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.abbr/Introduction The abbr module manages Hilbish abbreviations. These are words that can be replaced with longer command line strings when entered. As an example, git push can be abbreviated to gp. When the user types gp into the command line, after hitting space or enter, it will expand to git push. Abbreviations can be used as an alternative to aliases. They are saved entirely in the history Instead of the aliased form of the same command.Module hilbish.aliaseshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/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) Removes an alias. list() -> table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -> string? Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.Module hilbish.completionhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/Introduction The completions interface deals with tab completions. -Functions bins(query, ctx, fields) -> entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -> completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -> entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.Module hilbish.editorhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.editor/Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use. -Functions deleteByAmount(amount) Deletes characters in the line by the given amount. getLine() -> string Returns the current input line. getVimRegister(register) -> string Returns the text that is at the register. insert(text) Inserts text into the Hilbish command line. getChar() -> string Reads a keystroke from the user. This is in a format of something like Ctrl-L.Module hilbish.historyhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.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 bins(query, ctx, fields) -> entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -> completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -> entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.Module hilbish.historyhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.history/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.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 add(cmd) Adds a command to the history. all() -> table Retrieves all history as a table. clear() Deletes all commands from the history. get(index) Retrieves a command from the history based on the index. size() -> number Returns the amount of commands in the history. hilbish.Module hilbish.jobshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.jobs/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) Creates a new job. This function does not run the job. This function is intended to be all() -> table[@Job] Returns a table of all job objects. disown(id) Disowns a job. This simply deletes it from the list of jobs without stopping it.Module hilbish.messageshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.messages/Introduction The messages interface defines a way for Hilbish-integrated commands, user config and other tasks to send notifications to alert the user.z The hilbish.message type is a table with the following keys: title (string): A title for the message notification. text (string): The contents of the message. channel (string): States the origin of the message, hilbish.* is reserved for Hilbish tasks. summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.Module hilbish.modulehttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.module/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/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. diff --git a/versions/readline-move/docs/api/index.html b/versions/readline-move/docs/api/index.html index 12b343fd..1ebb3bc3 100644 --- a/versions/readline-move/docs/api/index.html +++ b/versions/readline-move/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/versions/readline-move/docs/api/index.xml b/versions/readline-move/docs/api/index.xml index cf4c3b0c..cede94fb 100644 --- a/versions/readline-move/docs/api/index.xml +++ b/versions/readline-move/docs/api/index.xml @@ -1,8 +1,9 @@ API on Hilbishhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/Recent content in API on HilbishHugo -- gohugo.ioen-usModule baithttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/Introduction Bait is the event emitter for Hilbish. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to pick a unique name! Usage of the Bait module consists of userstanding event-driven architecture, but it’s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.Module commanderhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/Introduction Commander is the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander library in your Hilbish config. 1local commander = require 'commander' 2 3commander.register('hello', function(args, sinks) 4 sinks.out:writeln 'Hello world!' 5end) In this example, a command with the name of hello is created that will print Hello world!Module fshttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/Introduction The fs module provides filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does. -Functions abs(path) -> string Returns an absolute version of the path. basename(path) -> string Returns the “basename,” or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish’s directory to dir.Module readlinehttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/Introduction This package is designed to be run independently from murex and at some point it will be separated into it’s own git repository (at a stage when I am confident that murex will no longer be the primary driver for features, bugs or other code changes) -line reader library The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything.Module snailhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/Introduction The snail library houses Hilbish’s Lua wrapper of its shell script interpreter. It’s not very useful other than running shell scripts, which can be done with other Hilbish functions. +Functions abs(path) -> string Returns an absolute version of the path. basename(path) -> string Returns the “basename,” or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish’s directory to dir.Module readlinehttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/Introduction The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything. The global Hilbish readline instance is usable at hilbish.editor. +Functions new() -> @Readline Creates a new readline instance. readline.new() -> Readline Creates a new readline instance. +Parameters This function has no parameters.Module snailhttps://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/Introduction The snail library houses Hilbish’s Lua wrapper of its shell script interpreter. It’s not very useful other than running shell scripts, which can be done with other Hilbish functions. Functions new() -> @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance. Parameters This function has no parameters. Types Snail A Snail is a shell script interpreter instance. diff --git a/versions/readline-move/docs/api/readline/index.html b/versions/readline-move/docs/api/readline/index.html index a8e302c1..ff629338 100644 --- a/versions/readline-move/docs/api/readline/index.html +++ b/versions/readline-move/docs/api/readline/index.html @@ -1,25 +1,23 @@ -Module readline — Hilbish +Module readline — Hilbish

Module readline

Package readline is a pure-Go re-imagining of the UNIX readline API

Introduction -

This package is designed to be run independently from murex and at some -point it will be separated into it’s own git repository (at a stage when I -am confident that murex will no longer be the primary driver for features, -bugs or other code changes)

line reader library -The readline module is responsible for reading input from the user. +

Module readline

line reader library

Introduction +

The readline module is responsible for reading input from the user. The readline module is what Hilbish uses to read input from the user, including all the interactive features of Hilbish like history search, syntax highlighting, everything. The global Hilbish readline instance -is usable at hilbish.editor.

Package terminal provides support functions for dealing with terminals, as -commonly found on UNIX systems.

Putting a terminal into raw mode is the most common requirement:

oldState, err := terminal.MakeRaw(0)
-if err != nil {
-        panic(err)
-}
-defer terminal.Restore(0, oldState)
-

Package terminal provides support functions for dealing with terminals, as -commonly found on UNIX systems.

Putting a terminal into raw mode is the most common requirement:

oldState, err := terminal.MakeRaw(0)
-if err != nil {
-        panic(err)
-}
-defer terminal.Restore(0, oldState)
-

Want to help improve this page? Create an issue.

\ No newline at end of file +is usable at hilbish.editor.

Functions +

new() -> @ReadlineCreates a new readline instance.

readline.new() -> Readline +

Creates a new readline instance.

Parameters +

This function has no parameters.

Types +

Readline +

blah blah

Methods +

deleteByAmount(amount) +

Deletes characters in the line by the given amount.

getLine() -> string +

Returns the current input line.

getVimRegister(register) -> string +

Returns the text that is at the register.

insert(text) +

Inserts text into the Hilbish command line.

log(text) +

Prints a message before the prompt without it being interrupted by user input.

read() -> string +

Reads input from the user.

getChar() -> string +

Reads a keystroke from the user. This is in a format of something like Ctrl-L.

setVimRegister(register, text) +

Sets the vim register at register to hold the passed text.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/readline-move/docs/api/snail/index.html b/versions/readline-move/docs/api/snail/index.html index 2508b44c..3c3f49f3 100644 --- a/versions/readline-move/docs/api/snail/index.html +++ b/versions/readline-move/docs/api/snail/index.html @@ -1,7 +1,7 @@ Module snail — Hilbish

Module snail

shell script interpreter library

Introduction +

Module snail

shell script interpreter library

Introduction

The snail library houses Hilbish’s Lua wrapper of its shell script interpreter. It’s not very useful other than running shell scripts, which can be done with other Hilbish functions.

Functions diff --git a/versions/readline-move/docs/api/terminal/index.html b/versions/readline-move/docs/api/terminal/index.html index a249110c..1ae54557 100644 --- a/versions/readline-move/docs/api/terminal/index.html +++ b/versions/readline-move/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()Saves the current state of the terminal.
setRaw()Puts the terminal into raw mode.
size()Gets the dimensions of the terminal. Returns a table with width and height

terminal.restoreState()

Restores the last saved state of the terminal

Parameters diff --git a/versions/readline-move/docs/completions/index.html b/versions/readline-move/docs/completions/index.html index 95928149..6c5fa571 100644 --- a/versions/readline-move/docs/completions/index.html +++ b/versions/readline-move/docs/completions/index.html @@ -1,7 +1,7 @@ Completions — Hilbish

Completions

Tab completion for commands.

Completions for commands can be created with the hilbish.complete +

Completions

Tab completion for commands.

Completions for commands can be created with the hilbish.complete function. See the link for how to use it.

To create completions for a command is simple. The callback will be passed 3 parameters: