Go to file
sammyette edcc1b39f0
docs: add todo to lua.go
2021-06-09 20:43:01 -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: make build for stable release more clear 2021-06-09 18:19:52 -04:00
go.mod chore: update urls to reflect org name change 2021-06-03 19:19:22 -04:00
go.sum chore: update urls to reflect org name change 2021-06-03 19:19:22 -04:00
hilbish.go feat: add hilbish.cwd function 2021-05-27 19:06:17 -04:00
lua.go docs: add todo to lua.go 2021-06-09 20:43:01 -04:00
main.go feat: support comptime sample conf declaration 2021-06-09 20:33:30 -04:00
preload.lua fix: return 0 exit code when cd with noarg instead of throwing hook explicitly 2021-06-09 20:30:12 -04:00
rl.go feat: add back cancel input on ctrl c 2021-06-08 21:00:01 -04:00
rl_hilbiline.go feat: add back cancel input on ctrl c 2021-06-08 21:00:01 -04:00
shell.go fix: check aliases before going to sh interp 2021-06-09 19:16:08 -04:00
shell.nix feat: adds shell.nix (#26) 2021-04-18 15:51:25 +00:00
vars.go feat: support comptime sample conf declaration 2021-06-09 20:33:30 -04:00

README.md

Hilbish

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

help wanted

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





Links

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.


AUR

Arch Linux users can install Hilbish from the AUR.

yay -S hilbish

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

yay -S hilbish-git

Manual Build

Prerequisites

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

On Arch Linux, it can be installed with:

sudo pacman -S readline

Build

First, clone Hilbish:

git clone --recursive https://github.com/Hilbis/Hilbish
cd Hilbish
# If you want the latest stable release, run this following command
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

And get dependencies and build:

go get -d all
make dev

If you git checkout'd the latest stable release, run make build instead of make dev.
or want to experiment Hilbiline, instead run make hilbiline

Install

sudo make install

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.