Go to file

sammyette 459606618c docs: add that precompiled binaries are provided, more details in install		2021-05-20 19:11:07 -04:00
.github	ci: set fetch depth to 0	2021-05-20 18:48:16 -04:00
gallery	docs: add screenshots of hilbish	2021-04-08 14:03:26 -04:00
golibs	feat: print on unhandled err case for fs.cd	2021-05-19 17:00:23 -04:00
libs	feat: add lunacolors library	2021-05-01 16:05:02 -04:00
.gitignore	chore: update .gitignore	2021-04-09 18:22:28 -04:00
.gitmodules	feat: add lunacolors library	2021-05-01 16:05:02 -04:00
.hilbishrc.lua	fix: use new way to get username in default config	2021-05-16 17:40:55 -04:00
CONTRIBUTING.md	docs: more content to CONTRIBUTING.md	2021-04-08 14:47:15 -04:00
LICENSE	Initial commit	2021-03-19 10:26:58 -04:00
Makefile	build: add link flags -s and -w to build	2021-05-17 19:38:53 -04:00
README.md	docs: add that precompiled binaries are provided, more details in install	2021-05-20 19:11:07 -04:00
go.mod	chore(deps): update dependencies	2021-05-18 20:40:41 -04:00
go.sum	chore(deps): update dependencies	2021-05-18 20:40:41 -04:00
hilbish.go	feat: add hilbish.flag function	2021-05-16 18:10:46 -04:00
lua.go	refactor: make `hilbish` an already required module and add run function	2021-05-16 17:13:28 -04:00
main.go	feat: make readline agnostic, add hilbiline to test	2021-05-17 19:03:56 -04:00
preload.lua	feat: add command.not-found hook	2021-05-18 21:04:49 -04:00
rl.go	feat: make readline agnostic, add hilbiline to test	2021-05-17 19:03:56 -04:00
rl_hilbiline.go	feat: make readline agnostic, add hilbiline to test	2021-05-17 19:03:56 -04:00
shell.go	fix: check for lua defined commands before going to sh interp (mvdan/sh#705 )	2021-05-19 18:39:56 -04:00
shell.nix	feat: adds shell.nix (#26 )	2021-04-18 15:51:25 +00:00

README.md

Hilbish

🎀 a nice lil shell for lua people made with go and lua

Hilbish is an interactive Unix-like shell written in Go, with the config and other code written in Lua.
It is sort of in a stable state currently, usable as a daily shell, but there may still be breaking changes in Lua modules.

Screenshots

Installation

NOTE: Hilbish is currently only officially supported and tested on Linux

Prebuilt binaries

Binaries are provided for the latest commit.

Note that these use Hilbiline, not readline, and may be missing functionality (moving the cursor, proper unicode support and backspace working properly)

Click on the checkmark (or x) near the commit hash, then details for your platform

Then click on the artifacts drop down, and download artifact for your platform, like what is highlighted in the screenshot.

Manual Build

Prerequisites

Go 1.16
GNU Readline On Fedora, readline can be installed with:

sudo dnf install readline-devel

On Debian/Ubuntu and distros based on them, it can be installed with:

sudo apt install libreadline-dev

On OpenSUSE, it can be installed with:

sudo zypper install readline-devel

Install

First, clone Hilbish:

git clone --recursive https://github.com/Hilbis/Hilbish
cd Hilbish

And get dependencies:

go get -d

then, build and install:

make dev
sudo make install
# Or 
sudo make all

Or, if you want the latest stable release:

git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
make build
sudo make install

If you want to use Hilbiline instead, replace make dev/make build with make hilbiline. make build all will still try to use readline.

Alternatively, if you use Arch Linux, you can compile Hilbish with an (unofficial) AUR package:

yay -S hilbish

If you want the latest and greatest, you can install and compile from latest git commit:

yay -S hilbish-git

Uninstall

sudo make uninstall

Contributing

Any kind of contributions to Hilbish are welcome!
Make sure to read CONTRIBUTING.md before getting started.

Special Thanks To

Everyone here who has contributed:

Made with contributors-img.

Credits

This blog post which is how Hilbish now inserts a newline even if output doesn't have one.

License

Hilbish is licensed under the MIT license.
Read here for more info.