this introduces a breaking change to runner functions. they are now required to return 3 values, the first being the user's input, and the 2 others that it was before. the `hilbish.runner` functions respectively have been updated, so if you just return from those there will be no difference
Hilbish is a extensible shell (framework). It was made to be very customizable via the Lua programming language. It aims to be easy to use for the casual people but powerful for those who want to tinker more with their shell, the thing used to interface with most of the system.
The motivation for choosing Lua was that its simpler and better to use than old shell script. It's fine for basic interactive shell uses, but that's the only place Hilbish has shell script; everything else is Lua and aims to be infinitely configurable. If something isn't, open an issue!
Table of Contents
Go here for builds on the master branch.
yay -S hilbish
yay -S hilbish-git
Nix/NixOS users can install Hilbish from the central repository, nixpkgs, through the usual ways. If you're new to nix you should probably read up on how to do that here.
First, clone Hilbish. The recursive is required, as some Lua libraries are submodules.
git clone --recursive https://github.com/Rosettea/Hilbish cd Hilbish go get -d ./...
To build, run:
Or, if you want a stable branch, run these commands:
git checkout $(git describe --tags `git rev-list --tags --max-count=1`) make build
After you did all that, run
sudo make install to install Hilbish globally.
At startup, you should see a message which says to run a
This guide is a very simple and basic step through text of what Hilbish is
and where to find documentation.
Documentation is primarily viewed via the in shell
Autogenerated function docs and general docs about other things are included
there, so be sure to read it.
Using Hilbish is the same as using any other Linux shell, with an addition
that you can also run Lua. Hilbish can also act as an enhanced Lua REPL
hilbish.runnerMode 'lua'. To switch back to normal, use
Any kind of contributions are welcome! Hilbish is very easy to contribute to. Read CONTRIBUTING.md as a guideline to doing so.
Made with contributors-img.