Go to file
sammyette df70082a81
feat: add doc command (closes #76)
the `doc` command is a way to see hilbish documentation from
in the shell. for usage, just run the command
2021-10-16 15:42:55 -04:00
.github ci: set fetch depth to 0 2021-05-20 18:48:16 -04:00
assets docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
cmd/docgen fix(docgen): use better perm mask for output files and folder 2021-10-16 15:38:17 -04:00
docs docs: add docs for functions 2021-10-16 15:38:49 -04:00
gallery docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
golibs docs: make linebreaks to descriptions for better alignment 2021-10-16 15:36:30 -04:00
libs feat: include inspect in hilbish libs 2021-10-13 19:29:10 -04:00
util docs: document `hilbish` module functions, xdg vars, and add descriptions for modules 2021-10-16 12:41:10 -04:00
.gitignore feat: add docgen program, document almost all hilbish functions 2021-10-16 10:21:05 -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 docs folder to makefile 2021-10-16 15:33:22 -04:00
README.md docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
changelog.md docs: add changelog.md (#72) 2021-10-09 11:15:25 -04:00
go.mod fix: break for loop after finding the aliased command (#73) 2021-10-11 21:45:52 -04:00
go.sum fix: break for loop after finding the aliased command (#73) 2021-10-11 21:45:52 -04:00
hilbish.go fix: stop using setField wrapper 2021-10-16 15:40:16 -04:00
lua.go chore: remove unused setField func 2021-10-16 15:33:57 -04:00
main.go fix: throw command.exit with 0 code if input is nothing 2021-10-13 22:51:38 -04:00
preload.lua feat: add doc command (closes #76) 2021-10-16 15:42:55 -04:00
rl.go chore: move comments below package declaration 2021-10-16 11:31:01 -04:00
rl_hilbiline.go chore: move comments below package declaration 2021-10-16 11:31:01 -04:00
shell.go feat: add command.preexec hook 2021-10-14 08:51:29 -04:00
shell.nix feat: adds shell.nix (#26) 2021-04-18 15:51:25 +00:00
vars.go feat: add default history dir to xdg dir, or fallback to home 2021-10-13 10:42:35 -04:00
vars_linux.go chore: add dataDir var 2021-10-14 19:46:25 -04:00
vars_windows.go chore: add dataDir var 2021-10-14 19:46:25 -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 new, Unix-like shell which uses Lua as its configuration language. It's decently fast for interactive use and includes a bunch of utility functions and features to make your life in a terminal easier.

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

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

yay -S hilbish

Or from the latest master commit with:

yay -S hilbish-git

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! Read the license here for more info.

Images in the assets folder are under CC-BY-SA 4.0