Go to file
TorchedSammy 00d7942e1c
docs(website): fix description for home page
2022-06-21 23:31:21 -04:00
.github ci(website): combine cd and hugo in 1 run cmd 2022-06-21 22:36:51 -04:00
assets docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
cmd/docgen fix(docgen): make functions that take varargs have the signature 2022-04-04 21:34:46 -04:00
docs docs: [ci] generate new docs 2022-06-20 20:47:56 +00:00
emmyLuaDocs docs: [ci] generate new docs 2022-06-20 20:47:56 +00:00
gallery docs: update image for readme gallery 2022-03-22 21:19:36 -04:00
golibs feat(fs): add some functions and properties (closes #168) 2022-06-20 16:47:16 -04:00
libs chore!: update lunacolors 2022-05-21 21:26:34 -04:00
nature feat: auto start lua modules (closes #167) 2022-06-20 17:07:15 -04:00
readline fix: check if input is 0 on multiline splitting (closes #170) 2022-06-20 15:35:25 -04:00
util refactor: move out home abbreviating code to a util function 2022-05-17 21:37:42 -04:00
website docs(website): fix description for home page 2022-06-21 23:31:21 -04:00
.gitignore feat: add docgen program, document almost all hilbish functions 2021-10-16 10:21:05 -04:00
.gitmodules chore: update lunacolors 2022-03-13 16:37:33 -04:00
.hilbishrc.lua refactor: remove mode from prompt func in default conf and dont refresh in vim mode 2022-03-13 16:12:34 -04:00
CHANGELOG.md feat: auto start lua modules (closes #167) 2022-06-20 17:07:15 -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
Makefile fix: change how version is retrieved 2022-05-16 19:36:34 -04:00
README.md docs: fix hilbish typo 2022-04-03 21:43:13 -04:00
aliases.go feat: add hilbish.aliases.resolve to resolve an alias 2022-04-23 12:28:28 -04:00
api.go refactor!: use userdata where appropriate (#157) 2022-05-28 19:03:44 -04:00
complete.go fix: implicitly expand tilde on args to all fs functions 2022-05-01 00:49:59 -04:00
editor.go fix: typo in editor interface 2022-05-13 20:52:30 -04:00
exec.go fix: handle lua eval errors and normal runner errors separately 2022-06-20 15:47:19 -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 to popen branch 2022-06-20 20:33:09 -04:00
go.sum chore: fix go sum 2022-06-20 20:37:54 -04:00
history.go feat: make history clear function work again 2022-03-22 19:01:29 -04:00
init_windows.go fix: broken ansi escape codes on windows cmd 2022-05-28 09:07:28 -04:00
job.go refactor!: use userdata where appropriate (#157) 2022-05-28 19:03:44 -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: print error if nature is missing 2022-05-06 19:21:32 -04:00
main.go perf: use waitgroup instead of loop to wait on timers 2022-05-21 21:58:58 -04:00
rl.go feat: allow overwrite of completion handler (closes #122) 2022-04-23 00:03:47 -04:00
runnermode.go feat: allow runners to specify if they want more input (#162) 2022-06-02 22:33:30 -04:00
signal_unix.go feat: implement job foregrounding/backgrounding (#155) 2022-05-24 19:15:02 -04:00
signal_windows.go fix: only notify ctrl c signal on windows 2022-02-28 16:15:08 -04:00
timer.go refactor!: use userdata where appropriate (#157) 2022-05-28 19:03:44 -04:00
timerhandler.go refactor!: use userdata where appropriate (#157) 2022-05-28 19:03:44 -04:00
vars.go fix: change how version is retrieved 2022-05-16 19:36:34 -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 refactor: (re)organize and change prelude path and structure 2022-04-23 00:03:50 -04:00
vars_windows.go refactor: (re)organize and change prelude path and structure 2022-04-23 00:03:50 -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





Installation

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.

Getting Started

At startup, you should see a message which says to run a guide command. This guide is a very simple and basic step through text of what Hilbish is and where to find documentation.

Documentation is primarily viewed via the in shell doc command. Autogenerated function docs and general docs about other things are included there, so be sure to read it.

Using Hilbish is the same as using any other Linux shell, with an addition that you can also run Lua. Hilbish can also act as an enhanced Lua REPL via hilbish.runnerMode 'lua'. To switch back to normal, use hilbish.runnerMode 'hybrid'.

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