Go to file
sammyette 650b45b930
docs: allow linking to types on different pages, improve docs for hilbish functions
2023-01-07 14:58:13 -04:00
.github ci: revert using task and set ldflags 2022-12-20 22:14:04 -04:00
assets docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
cmd/docgen docs: allow linking to types on different pages, improve docs for hilbish functions 2023-01-07 14:58:13 -04:00
docs docs: allow linking to types on different pages, improve docs for hilbish functions 2023-01-07 14:58:13 -04:00
emmyLuaDocs docs: allow linking to types on different pages, improve docs for hilbish functions 2023-01-07 14:58:13 -04:00
gallery chore: upload gallery image 2022-12-28 20:24:59 -04:00
golibs docs: improve emmy lua annotations 2022-12-20 20:59:55 -04:00
libs chore: update lunacolors 2022-12-05 14:16:43 -04:00
nature chore: merge from master 2023-01-07 14:21:30 -04:00
readline fix(readline): dont do anything if length of input rune slice is 0 2022-12-10 17:27:42 -04:00
util refactor: remove doc prop related code 2022-12-20 00:54:05 -04:00
website docs: document job type 2023-01-07 12:35:06 -04:00
.editorconfig chore: add .editorconfig file (#217) 2022-12-01 09:29:27 -04:00
.gitignore refactor!: rework docs and doc command (#218) 2022-12-15 00:00:54 -04:00
.gitmodules chore: update lunacolors 2022-03-13 16:37:33 -04:00
.hilbishrc.lua refactor!: move hilbish.greeting to an opt (closes #184) 2022-07-09 17:15:13 -04:00
.hugo_build.lock chore: merge from master 2023-01-07 14:21:30 -04:00
CHANGELOG.md chore: add 2.0.1 tag to changelog 2022-12-28 20:53:38 -04:00
CONTRIBUTING.md docs: update contributing info to include writing changes to changelog 2022-05-30 18:16:36 -04:00
LICENSE chore: update license 2022-02-12 16:46:41 -04:00
README.md docs: reorder screenshots, add showcase of history search menu 2022-12-28 20:21:11 -04:00
Taskfile.yaml chore: add rpm spec file (package for copr/fedora) (#220) 2022-12-19 23:19:48 -04:00
aliases.go docs: fix return type for hilbish.aliases.list 2023-01-07 11:52:05 -04:00
api.go docs: allow linking to types on different pages, improve docs for hilbish functions 2023-01-07 14:58:13 -04:00
complete.go docs: improve emmy lua annotations 2022-12-20 20:59:55 -04:00
editor.go docs: improve emmy lua annotations 2022-12-20 20:59:55 -04:00
exec.go refactor: remove doc prop related code 2022-12-20 00:54:05 -04:00
execfile_unix.go feat: job enhancements (#153) 2022-05-21 20:53:36 -04:00
execfile_windows.go feat: job enhancements (#153) 2022-05-21 20:53:36 -04:00
go.mod chore: update golua for popen (#172) 2022-12-13 15:37:01 -04:00
go.sum chore: update golua for popen (#172) 2022-12-13 15:37:01 -04:00
hilbish-git.spec chore: add rpm spec file (package for copr/fedora) (#220) 2022-12-19 23:19:48 -04:00
history.go perf: preallocate history slice 2022-11-30 13:20:00 -04:00
init_windows.go fix: set vt in on stdin 2022-07-13 15:11:06 -04:00
job.go docs: add descriptions for types 2023-01-07 14:25:57 -04:00
job_unix.go feat: implement job foregrounding/backgrounding (#155) 2022-05-24 19:15:02 -04:00
job_windows.go feat: implement job foregrounding/backgrounding (#155) 2022-05-24 19:15:02 -04:00
lua.go feat(bait): add error hook and hooks function (closes #205) 2022-10-11 17:41:13 -04:00
main.go feat: add hilbish.cancel hook (closes #213) 2022-11-25 19:21:36 -04:00
os.go refactor: remove doc prop related code 2022-12-20 00:54:05 -04:00
rl.go refactor!: rework docs and doc command (#218) 2022-12-15 00:00:54 -04:00
rpkg.conf chore: add rpm spec file (package for copr/fedora) (#220) 2022-12-19 23:19:48 -04:00
rpkg.macros chore: add rpm spec file (package for copr/fedora) (#220) 2022-12-19 23:19:48 -04:00
runnermode.go docs: improve emmy lua annotations 2022-12-20 20:59:55 -04:00
signal_unix.go refactor: use custom event emitter (#193) 2022-08-17 18:01:32 -04:00
signal_windows.go refactor: use custom event emitter (#193) 2022-08-17 18:01:32 -04:00
timer.go docs: add descriptions for types 2023-01-07 14:25:57 -04:00
timerhandler.go docs: document timer type, update generated docs 2023-01-07 12:57:34 -04:00
userdir.go refactor: remove doc prop related code 2022-12-20 00:54:05 -04:00
vars.go chore: update version 2022-12-28 22:23:47 -04:00
vars_darwin.go refactor: (re)organize and change prelude path and structure 2022-04-23 00:03:50 -04:00
vars_linux.go build!: set datadir of hilbish and change default prefix to /usr/local (#221) 2022-12-12 21:01:44 -04:00
vars_windows.go fix: add dot to sample config path on windows 2022-08-16 12:30:39 -04:00

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