Go to file
sammyette f7e66bb957
docs: bump version requirement
2024-07-19 09:48:40 -04:00
.github ci: update all actions () 2024-05-03 12:47:24 -04:00
assets refactor: website/branding cleanup () 2023-04-14 00:04:52 -04:00
cmd/docgen feat: allow hilbish.run to take a table of files to use for output () 2024-04-27 21:03:54 -04:00
docs docs: [ci] generate new docs 2024-04-28 01:29:33 +00:00
emmyLuaDocs docs: [ci] generate new docs 2024-04-28 01:29:33 +00:00
gallery chore: upload gallery image 2022-12-28 20:24:59 -04:00
golibs feat(commander): add function to return all commanders (closes ) 2024-04-27 21:29:06 -04:00
libs chore: update lunacolors 2022-12-05 14:16:43 -04:00
nature fix(greenhouse): reset at end and beginning of line to fix colors leaking to other lines 2024-05-03 19:06:17 -04:00
readline fix: history navigation going out of bounds 2024-06-14 08:23:20 -04:00
testplugin feat: native modules () 2023-11-11 19:39:31 -05:00
util feat: add fuzzy searching for completion and history search () 2023-07-10 00:06:29 -04:00
website website: add 2.2 release blog 2023-12-26 00:13:50 -04:00
.editorconfig chore: add .editorconfig file () 2022-12-01 09:29:27 -04:00
.gitignore docs: document types properly () 2023-01-18 06:39:26 -04:00
.gitmodules chore: update lunacolors 2022-03-13 16:37:33 -04:00
.hilbishrc.lua feat: add notification/message interface () 2023-07-10 19:03:30 -04:00
CHANGELOG.md fix(greenhouse): reset at end and beginning of line to fix colors leaking to other lines 2024-05-03 19:06:17 -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 2023-01-20 19:35:33 -04:00
README.md docs: bump version requirement 2024-07-19 09:48:40 -04:00
Taskfile.yaml feat: native modules () 2023-11-11 19:39:31 -05:00
aliases.go refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
api.go feat(commander): add function to return all commanders (closes ) 2024-04-27 21:29:06 -04:00
complete.go feat(commander): add function to return all commanders (closes ) 2024-04-27 21:29:06 -04:00
editor.go refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
exec.go feat(commander): add function to return all commanders (closes ) 2024-04-27 21:29:06 -04:00
execfile_unix.go feat: job enhancements () 2022-05-21 20:53:36 -04:00
execfile_windows.go feat: job enhancements () 2022-05-21 20:53:36 -04:00
go.mod feat: allow hilbish.run to take a table of files to use for output () 2024-04-27 21:03:54 -04:00
go.sum feat: allow hilbish.run to take a table of files to use for output () 2024-04-27 21:03:54 -04:00
hilbish-git.spec chore: add rpm spec file (package for copr/fedora) () 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 refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
job_unix.go feat: implement job foregrounding/backgrounding () 2022-05-24 19:15:02 -04:00
job_windows.go feat: implement job foregrounding/backgrounding () 2022-05-24 19:15:02 -04:00
lua.go feat(commander): add function to return all commanders (closes ) 2024-04-27 21:29:06 -04:00
main.go fix: make -S flag set absolute path to hilbish 2024-06-25 16:48:32 -04:00
module.go refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
os.go refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
pprof.go feat: add pprof 2023-12-18 21:31:04 -04:00
rl.go fix: call highlighter and hinter from global table (closes ) 2024-04-19 07:54:46 -04:00
rpkg.conf chore: add rpm spec file (package for copr/fedora) () 2022-12-19 23:19:48 -04:00
rpkg.macros chore: add rpm spec file (package for copr/fedora) () 2022-12-19 23:19:48 -04:00
runnermode.go refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
signal_unix.go refactor: use custom event emitter () 2022-08-17 18:01:32 -04:00
signal_windows.go refactor: use custom event emitter () 2022-08-17 18:01:32 -04:00
sink.go feat: hilbish native pager () 2023-10-25 00:41:53 -04:00
timer.go docs: add docs for sink type (closes ) 2023-02-07 15:39:22 -04:00
timerhandler.go refactor: doc improvements (again) () 2023-12-25 22:08:29 -05:00
userdir.go refactor: remove doc prop related code 2022-12-20 00:54:05 -04:00
vars.go chore: bump version 2024-04-27 10:49:26 -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 () 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 Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺

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

Hilbish is an extensible shell designed to be highly customizable. It is configured in Lua and provides a good range of features. It aims to be easy to use for anyone but powerful enough for those who need it.

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!

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. If you want to contribute to make the situation better, comment on the Windows discussion.

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.22+
  • 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