Go to file
TorchedSammy 76c94bfcce
docs: fix docs for hilbish.complete
2022-03-05 16:12:46 -04:00
.github ci: add .exe to windows artifacts 2022-03-02 06:44:46 -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] generate new docs 2022-03-02 02:01:22 +00:00
emmyLuaDocs docs: [ci] generate new docs 2022-03-04 18:41:22 +00:00
gallery docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
golibs docs(fs): change bool to boolean 2022-02-25 18:17:04 -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 docs: add more detail to changelog and make it up to date 2022-03-03 20:07:06 -04:00
CONTRIBUTING.md docs: bring contributing guide up to date 2022-02-25 18:22:59 -04:00
LICENSE chore: update license 2022-02-12 16:46:41 -04:00
Makefile refactor: remove gnu readline 2022-02-27 19:27:18 -04:00
README.md docs: remove readline requirement, use nightly links 2022-03-02 06:58:55 -04:00
aliases.go fix: use a rwmutex for aliases map 2021-12-19 22:37:44 -04:00
api.go docs: fix docs for hilbish.complete 2022-03-05 16:12:46 -04:00
complete.go refactor!: completion api, add hilbish.completion interface 2022-03-05 15:59:00 -04:00
exec.go refactor!: completion api, add hilbish.completion interface 2022-03-05 15:59:00 -04:00
go.mod chore: update readline 2022-03-05 14:40:38 -04:00
go.sum chore: update readline 2022-03-05 14:40:38 -04:00
history.go fix: add back prompt global var 2022-03-05 15:46:38 -04:00
lua.go refactor!: remove .hprofile.lua 2022-02-26 12:14:26 -04:00
main.go fix: add back prompt global var 2022-03-05 15:46:38 -04:00
preload.lua refactor: remove global module from doc command (closes #90) 2022-02-24 18:19:54 -04:00
rl.go refactor!: completion api, add hilbish.completion interface 2022-03-05 15:59:00 -04:00
signal_unix.go fix: only notify ctrl c signal on windows 2022-02-28 16:15:08 -04:00
signal_windows.go fix: only notify ctrl c signal on windows 2022-02-28 16:15:08 -04:00
vars.go fix: add back prompt global var 2022-03-05 15:46:38 -04:00
vars_darwin.go feat: support macos 2022-02-28 18:53:58 -04:00
vars_linux.go refactor!: replace hilbish.xdg with hilbish.userDir 2021-12-13 20:13:17 -04:00
vars_windows.go fix: correct require paths on windows 2022-02-25 21:34:30 -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

Go here for builds on the master branch.

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

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:

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