4.1 KiB
🌓 The Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺 ✨
Midnight Edition
[!CAUTION] This is a HEAVILY WORK IN PROGRESS branch which makes a lot of internal changes. Functionality will be missing if you use this branch, and you may see crashes too. Tread lightly.
Progress on Midnight Edition is tracked in this PR: #314
Hilbish: Midinight Edition is a version of Hilbish meant to be compatible with the original C implementation of Lua by using a Go library binding. The end goal is to offer Midnight Edition as a separate, "not as supported" build for users that really want to access a certain library made for C Lua or want the most performance with their Lua code.
The standard edition, which is all native Go, will always be more supported than Midnight Edition.
Back the original README
Hilbish is an extensible shell designed to be highly customizable. It is configured in Lua and provides a good range of features. It aims to be easy to use for anyone but powerful enough for those who need it.
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!
Screenshots
Getting Hilbish
NOTE: Hilbish is not guaranteed to work properly on Windows, starting from the 2.0 version. It will still be able to compile, but functionality may be lacking. If you want to contribute to make the situation better, comment on the Windows discussion.
You can check the install page on the website for distributed binaries from GitHub or other package repositories. Otherwise, continue reading for steps on compiling.
Prerequisites
Build
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:
task
Or, if you want a stable branch, run these commands:
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
task build
After you did all that, run sudo task install to install Hilbish globally.
Contributing
Any kind of contributions are welcome! Hilbish is very easy to contribute to. Read CONTRIBUTING.md as a guideline to doing so.
Thanks to everyone below who's contributed!
Made with contributors-img.
License
Hilbish is licensed under the MIT license.
Images and assets are licensed under CC-BY-SA 4.0