sammyette
4150001d8b
* fix: make lua implemented hilbish interfaces documented * fix: signature link in table of contents * fix: reduce function list to match in go generated docs * fix: toc appending * docs: enable docs for hilbish.messages * feat: add description gen, and more spacing between param listing * docs: add more detailed documentation for lua modules * docs: update hilbish.messages docs * fix: add description for lua doc'd modules, remove duplicate docs * docs: add back hilbish.jobs doc * feat: generate toc for lua modules * fix: add table heading * ci: add lua docgen * docs: put dirs.old doc on 1 line
Tip
Check out Hilbish: Midnight Edition if you want to use C Lua, LuaJIT or anything related!
🌓 The Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺 ✨
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, and powerful enough for those who need more.
The motivation for choosing Lua was that its simpler and better to use than old shell scripts. It's fine for basic interactive shell uses, and supports both Lua and Sh interactively.
That's the only place Hilbish can use traditional shell syntax though; 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