Go to file
TorchedSammy a77b997942
refactor: add emmylua docs for all functions appropriate
2022-02-25 18:15:25 -04:00
.github ci: change regen to just gen 2022-02-25 18:04:34 -04:00
assets docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
cmd/docgen feat(docgen): support outputting emmylua sources (closes #91) 2022-02-25 18:00:18 -04:00
docs docs: [ci] regenerate new docs 2022-02-25 22:00:39 +00:00
emmyLuaDocs docs: [ci] regenerate new docs 2022-02-25 22:00:39 +00:00
gallery docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
golibs refactor: add emmylua docs for all functions appropriate 2022-02-25 18:15:25 -04:00
libs style: dont redeclare function param, just assign 2021-12-04 17:56:45 -04:00
util fix: only add __docProp metatable from SetField function 2021-11-22 19:19:36 -05:00
.gitignore feat: add docgen program, document almost all hilbish functions 2021-10-16 10:21:05 -04:00
.gitmodules fix: add back inspect 2021-10-17 18:51:44 -04:00
.hilbishrc.lua fix: make default config work with breaking changes 2022-02-23 21:14:49 -04:00
CHANGELOG.md chore: make changelogs and bump for 0.7.1 2021-11-22 22:54:20 -05:00
CONTRIBUTING.md docs(contributing): fix sentence in making pr section 2021-12-08 23:04:30 -04:00
LICENSE chore: update license 2022-02-12 16:46:41 -04:00
Makefile build: add docs folder to makefile 2021-10-16 15:33:22 -04:00
README.md docs: add newline after aur badge 2021-12-19 22:41:04 -04:00
aliases.go fix: use a rwmutex for aliases map 2021-12-19 22:37:44 -04:00
api.go refactor!: use better default paths 2022-02-23 22:19:54 -04:00
exec.go style: tiny style changes/fixes 2022-01-31 17:43:12 -04:00
go.mod chore: clean up and update modules 2022-01-02 19:21:34 -04:00
go.sum chore: clean up and update modules 2022-01-02 19:21:34 -04:00
lua.go fix: use right function to set prompt in minimal config 2022-01-27 17:01:27 -04:00
main.go fix: dont copy default conf to user dir 2022-02-23 22:20:11 -04:00
preload.lua refactor: remove global module from doc command (closes #90) 2022-02-24 18:19:54 -04:00
rl.go feat: add hilbish.history interface (closes #85) 2022-01-27 17:02:21 -04:00
rl_hilbiline.go fix: use correct signature for rl lua loader 2022-01-31 17:46:24 -04:00
rl_readline-go.go fix: use correct signature for rl lua loader 2022-01-31 17:46:24 -04:00
shell.nix feat: adds shell.nix (#26) 2021-04-18 15:51:25 +00:00
vars.go chore: make changelogs and bump for 0.7.1 2021-11-22 22:54:20 -05:00
vars_linux.go refactor!: replace hilbish.xdg with hilbish.userDir 2021-12-13 20:13:17 -04:00
vars_windows.go refactor!: replace hilbish.xdg with hilbish.userDir 2021-12-13 20:13:17 -04:00

README.md



🌺 The flower shell. A comfy and nice little shell for Lua users and fans!

GitHub commit activity GitHub commits since latest release (by date) GitHub contributors
help wanted GitHub license Discord

Hilbish is a Unix-y shell which uses Lua for scripting. Things like the prompt, general configuration and such are done with Lua.

For interactive use, it uses a library to run sh which works on all platforms Hilbish can be compiled for. It can also act as a Lua REPL if you want it to be.

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.


AUR

AUR maintainer
Arch Linux users can install Hilbish from the AUR with the following command:

yay -S hilbish

AUR maintainer
Or from the latest master commit with:

yay -S hilbish-git

Nixpkgs

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.

Manual Build

Prerequisites

On Fedora or other RPM based distros, 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 Arch Linux, it can be installed with:

sudo pacman -S readline

Build

First, clone Hilbish:

git clone --recursive https://github.com/Rosettea/Hilbish
cd Hilbish
go get -d ./...

To build, run:

make dev

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.

Contributing

Any kind of contributions to Hilbish are welcome! Read CONTRIBUTING.md before getting started.

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