diff --git a/docs/api/bait/index.html b/docs/api/bait/index.html index e7e8b6d..5f2d700 100644 --- a/docs/api/bait/index.html +++ b/docs/api/bait/index.html @@ -2,7 +2,7 @@

Module bait

the event emitter

Introduction

Bait is the event emitter for Hilbish. Why name it bait? Why not. +

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 happened, like when you’ve changed directory, a command has failed, diff --git a/docs/api/commander/index.html b/docs/api/commander/index.html index 1d2f4d3..4ac0c5e 100644 --- a/docs/api/commander/index.html +++ b/docs/api/commander/index.html @@ -2,4 +2,4 @@

Module commander

library for custom commands

Introduction

Commander is a library for writing custom commands in Lua.

Functions

deregister(name)

Deregisters any command registered with name

register(name, cb)

Register a command with name that runs cb when ran

Want to help improve this page? Create an issue.

\ No newline at end of file +

Module commander

library for custom commands

Introduction

Commander is a library for writing custom commands in Lua.

Functions

deregister(name)

Deregisters any command registered with name

register(name, cb)

Register a command with name that runs cb when ran

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/fs/index.html b/docs/api/fs/index.html index 9b0218d..84fba03 100644 --- a/docs/api/fs/index.html +++ b/docs/api/fs/index.html @@ -2,7 +2,7 @@

Module fs

filesystem interaction and functionality library

Introduction

The fs module provides easy and simple access to filesystem functions +

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

abs(path)

Gives an absolute version of path.

basename(path)

Gives the basename of path. For the rules, see Go’s filepath.Base

cd(dir)

Changes directory to dir

dir(path)

Returns the directory part of path. For the rules, see Go’s diff --git a/docs/api/hilbish/hilbish.aliases/index.html b/docs/api/hilbish/hilbish.aliases/index.html index e91bc4b..8241ed4 100644 --- a/docs/api/hilbish/hilbish.aliases/index.html +++ b/docs/api/hilbish/hilbish.aliases/index.html @@ -2,4 +2,4 @@

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)

Removes an alias.

list()

Get a table of all aliases.

resolve(alias)

Tries to resolve an alias to its command.

Want to help improve this page? Create an issue.

\ No newline at end of file +

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)

Removes an alias.

list()

Get a table of all aliases.

resolve(alias)

Tries to resolve an alias to its command.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.completions/index.html b/docs/api/hilbish/hilbish.completions/index.html index 51a76bc..44c82d6 100644 --- a/docs/api/hilbish/hilbish.completions/index.html +++ b/docs/api/hilbish/hilbish.completions/index.html @@ -2,7 +2,7 @@

Interface hilbish.completions

tab completions

Introduction

The completions interface deals with tab completions.

Functions

call(name, query, ctx, fields)

Calls a completer function. This is mainly used to call +

Interface hilbish.completions

tab completions

Introduction

The completions interface deals with tab completions.

Functions

call(name, query, ctx, fields)

Calls a completer function. This is mainly used to call a command completer, which will have a name in the form of command.name, example: command.git

handler(line, pos)

The handler function is the callback for tab completion in Hilbish. You can check the completions doc for more info.

bins(query, ctx, fields)

Returns binary/executale completion candidates based on the provided query.

files(query, ctx, fields)

Returns file completion candidates based on the provided query.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.editor/index.html b/docs/api/hilbish/hilbish.editor/index.html index fece84f..07ea97f 100644 --- a/docs/api/hilbish/hilbish.editor/index.html +++ b/docs/api/hilbish/hilbish.editor/index.html @@ -2,5 +2,5 @@

Interface hilbish.editor

interactions for Hilbish's line reader

Introduction

The hilbish.editor interface provides functions to +

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()

Returns the current input line.

getVimRegister(register)

Returns the text that is at the register.

insert(text)

Inserts text into the line.

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/docs/api/hilbish/hilbish.history/index.html b/docs/api/hilbish/hilbish.history/index.html index 7a30d17..68cd4cf 100644 --- a/docs/api/hilbish/hilbish.history/index.html +++ b/docs/api/hilbish/hilbish.history/index.html @@ -2,6 +2,6 @@

Interface hilbish.history

command history

Introduction

The history interface deals with command history. +

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

add(cmd)

Adds a command to the history.

clear()

Deletes all commands from the history.

get(idx)

Retrieves a command from the history based on the idx.

size()

Returns the amount of commands in the history.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.jobs/index.html b/docs/api/hilbish/hilbish.jobs/index.html index e9192f4..ea01702 100644 --- a/docs/api/hilbish/hilbish.jobs/index.html +++ b/docs/api/hilbish/hilbish.jobs/index.html @@ -2,6 +2,6 @@

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 +

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.

Object properties

  • cmd: The user entered command string for the job.
  • running: Whether the job is running or not.
  • id: The ID of the job in the job table
  • pid: The Process ID
  • exitCode: The last exit code of the job.
  • stdout: The standard output of the job. This just means the normal logs of the process.
  • stderr: The standard error stream of the process. This (usually) includes error messages of the job.

Functions

background()

Puts a job in the background. This acts the same as initially running a job.

foreground()

Puts a job in the foreground. This will cause it to run like it was executed normally and wait for it to complete.

start()

Starts running the job.

stop()

Stops the job from running.

add(cmdstr, args, execPath)

Adds a new job to the job table. Note that this does not immediately run it.

all()

Returns a table of all job objects.

disown(id)

Disowns a job. This deletes it from the job table.

get(id)

Get a job object via its ID.

last() -> Job

Returns the last added job from the table.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.os/index.html b/docs/api/hilbish/hilbish.os/index.html index 5200cfc..3a7db3c 100644 --- a/docs/api/hilbish/hilbish.os/index.html +++ b/docs/api/hilbish/hilbish.os/index.html @@ -2,6 +2,6 @@

Interface hilbish.os

OS Info

Introduction

The os interface provides simple text information properties about +

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

  • family: Family name of the current OS
  • name: Pretty name of the current OS
  • version: Version of the current OS

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.runner/index.html b/docs/api/hilbish/hilbish.runner/index.html index 428ac0f..5dd338f 100644 --- a/docs/api/hilbish/hilbish.runner/index.html +++ b/docs/api/hilbish/hilbish.runner/index.html @@ -2,7 +2,7 @@

Interface hilbish.runner

interactive command runner customization

Introduction

The runner interface contains functions that allow the user to change +

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 language or script of their choosing. A good example is using it to diff --git a/docs/api/hilbish/hilbish.timers/index.html b/docs/api/hilbish/hilbish.timers/index.html index 808b5e4..52d3cc5 100644 --- a/docs/api/hilbish/hilbish.timers/index.html +++ b/docs/api/hilbish/hilbish.timers/index.html @@ -2,7 +2,7 @@

Interface hilbish.timers

timeout and interval API

Introduction

The timers interface si one to easily set timeouts and intervals +

Interface hilbish.timers

timeout and interval API

Introduction

The timers interface si one to easily set timeouts and intervals to run functions after a certain time or repeatedly without using odd tricks.

Object properties

  • type: What type of timer it is
  • running: If the timer is running
  • duration: The duration in milliseconds that the timer will run

Functions

start()

Starts a timer.

stop()

Stops a timer.

create(type, time, callback)

Creates a timer that runs based on the specified time in milliseconds. The type can either be interval (value of 0) or timeout (value of 1).

get(id)

Retrieves a timer via its ID.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/hilbish.userdir/index.html b/docs/api/hilbish/hilbish.userdir/index.html index ee76ba2..78d5806 100644 --- a/docs/api/hilbish/hilbish.userdir/index.html +++ b/docs/api/hilbish/hilbish.userdir/index.html @@ -2,6 +2,6 @@

Interface hilbish.userDir

user-related directories

Introduction

This interface just contains properties to know about certain user directories. +

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

  • config: The user’s config directory
  • data: The user’s directory for program data

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/index.html b/docs/api/hilbish/index.html index 03dddaf..774025d 100644 --- a/docs/api/hilbish/index.html +++ b/docs/api/hilbish/index.html @@ -2,7 +2,7 @@

Module hilbish

the core Hilbish API

Introduction

The Hilbish module includes the core API, containing +

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

alias(cmd, orig)

Sets an alias of cmd to orig

appendPath(dir)

Appends dir to $PATH

complete(scope, cb)

Registers a completion handler for scope. A scope is currently only expected to be command.<cmd>, replacing with the name of the command (for example command.git). diff --git a/docs/api/index.html b/docs/api/index.html index 26ce018..0ce36c7 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2,4 +2,4 @@

API

Want to help improve this page? Create an issue.

\ No newline at end of file +

API

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 664b4f0..577a5b8 100644 --- a/docs/api/terminal/index.html +++ b/docs/api/terminal/index.html @@ -2,5 +2,5 @@

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 in raw mode

size()

Gets the dimensions of the terminal. Returns a table with width and height +

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 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 display

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/faq/index.html b/docs/faq/index.html index 3209598..a959d26 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -6,7 +6,7 @@ Where is the API documentation?" name=description>

Frequently Asked Questions

Last updated Dec 13, 2022

Is Hilbish POSIX compliant?

No, it is not. POSIX compliance is a non-goal. Perhaps in the future, +

Frequently Asked Questions

Last updated Dec 13, 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?

It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you’d like to improve this situation, diff --git a/docs/features/index.html b/docs/features/index.html index 89f378e..95d3bc0 100644 --- a/docs/features/index.html +++ b/docs/features/index.html @@ -2,7 +2,7 @@

Features

Last updated Dec 13, 2022

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

Features

Last updated Dec 13, 2022

Hilbish has a wide range of features to enhance the user’s experience and is always adding new ones. 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/runner-mode/index.html b/docs/features/runner-mode/index.html index b6f1d67..2a96024 100644 --- a/docs/features/runner-mode/index.html +++ b/docs/features/runner-mode/index.html @@ -2,7 +2,7 @@

Runner Mode

Last updated Dec 13, 2022
Customize the interactive script/command runner.

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

Runner Mode

Last updated Dec 13, 2022
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 c0bb313..0c32238 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -4,7 +4,7 @@ Setting as Default Login shell There are a few ways to make Hilbish your default

Getting Started

Last updated Dec 13, 2022

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

Getting Started

Last updated Dec 13, 2022

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

Login shell

There are a few ways to make Hilbish your default shell. A simple way is diff --git a/docs/index.html b/docs/index.html index 7c2c0f1..bd18e9c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ Completion and history search menus Hinting and syntax highlighting (scripted by

Introduction

Last updated Dec 13, 2022

Here lies the documentation for Hilbish, the hyper extensible Lua shell.
Hilbish provides you with a few quality of life features and useful +

Introduction

Last updated Dec 13, 2022

Here lies the documentation for Hilbish, the hyper extensible Lua shell.
Hilbish provides you with a few quality of life features and useful functions to ensure you can make the shell fully yours.

These features include:

  • Completion and history search menus
  • Hinting and syntax highlighting (scripted by user)

Installation

Steps on installing Hilbish will be at the Install page in the navigation bar at the top. This also included getting development builds from the GitHub repository.

Want to help improve this page? Create an issue.

\ No newline at end of file