You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
TorchedSammy 0379e302ac
docs: [ci] generate new docs
6 days ago
.github ci: revert using task and set ldflags 3 months ago
assets docs: slight refactor of the readme 1 year ago
cmd/docgen docs: add docs for sink type (closes #233) 2 months ago
docs docs: [ci] generate new docs 6 days ago
emmyLuaDocs docs: [ci] generate new docs 6 days ago
gallery chore: upload gallery image 3 months ago
golibs docs: fix return types for functions (closes #229) 2 months ago
libs chore: update lunacolors 4 months ago
nature fix: correct job management commands to call with colon 1 month ago
readline fix(readline): dont do anything if length of input rune slice is 0 4 months ago
util refactor: remove doc prop related code 3 months ago
website website(blog/v2.1): link to release in blog 2 months ago
.editorconfig chore: add .editorconfig file (#217) 4 months ago
.gitignore docs: document types properly (#227) 2 months ago
.gitmodules chore: update lunacolors 1 year ago
.hilbishrc.lua refactor!: move hilbish.greeting to an opt (closes #184) 9 months ago
CHANGELOG.md feat: sink enhancements (#241) 6 days ago
CONTRIBUTING.md docs: update contributing info to include writing changes to changelog 10 months ago
LICENSE chore: update license 2 months ago
README.md docs: reorder screenshots, add showcase of history search menu 3 months ago
Taskfile.yaml fix: replace sed with vgrep (#238) 1 month ago
aliases.go docs: fix return type for hilbish.aliases.list 3 months ago
api.go fix: make hilbish.which work properly with aliases 2 months ago
complete.go docs: fix return types for functions (closes #229) 2 months ago
editor.go docs: fix return types for functions (closes #229) 2 months ago
exec.go feat: add sink for commanders to write output/read input (#232) 2 months ago
execfile_unix.go feat: job enhancements (#153) 10 months ago
execfile_windows.go feat: job enhancements (#153) 10 months ago
go.mod chore: update golua for popen (#172) 4 months ago
go.sum chore: update golua for popen (#172) 4 months ago
hilbish-git.spec chore: add rpm spec file (package for copr/fedora) (#220) 3 months ago
history.go perf: preallocate history slice 4 months ago
init_windows.go fix: set vt in on stdin 9 months ago
job.go docs: add docs for sink type (closes #233) 2 months ago
job_unix.go feat: implement job foregrounding/backgrounding (#155) 10 months ago
job_windows.go feat: implement job foregrounding/backgrounding (#155) 10 months ago
lua.go feat: add sink for commanders to write output/read input (#232) 2 months ago
main.go fix: initialize lua api before handling signals (fixes #236) 2 months ago
os.go refactor: remove doc prop related code 3 months ago
rl.go docs: fix return types for functions (closes #229) 2 months ago
rpkg.conf chore: add rpm spec file (package for copr/fedora) (#220) 3 months ago
rpkg.macros chore: add rpm spec file (package for copr/fedora) (#220) 3 months ago
runnermode.go docs: improve emmy lua annotations 3 months ago
signal_unix.go refactor: use custom event emitter (#193) 8 months ago
signal_windows.go refactor: use custom event emitter (#193) 8 months ago
sink.go feat: sink enhancements (#241) 6 days ago
timer.go docs: add docs for sink type (closes #233) 2 months ago
timerhandler.go docs: document types properly (#227) 2 months ago
userdir.go refactor: remove doc prop related code 3 months ago
vars.go chore: bump version to 2.2 1 month ago
vars_darwin.go refactor: (re)organize and change prelude path and structure 11 months ago
vars_linux.go build!: set datadir of hilbish and change default prefix to /usr/local (#221) 4 months ago
vars_windows.go fix: add dot to sample config path on windows 8 months ago

README.md



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

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

Hilbish is a extensible shell (framework). It was made to be very customizable via the Lua programming language. It aims to be easy to use for the casual people but powerful for those who want to tinker more with their shell, the thing used to interface with most of the system.

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!

Table of Contents

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.

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

  • Go 1.17+
  • Task (Go on the hyperlink here to see Task's install method for your OS.)

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