Go to file
TorchedSammy e5d841a0a7 docs: [ci] generate new docs 2022-03-26 22:26:10 +00:00
.github ci: remove fetch-depth 0 setting for checkout 2022-03-22 18:41:26 -04:00
assets docs: slight refactor of the readme 2021-10-12 16:01:17 -04:00
cmd/docgen feat(docgen): support outputting emmylua sources (closes #91) 2022-02-25 18:00:18 -04:00
docs docs: [ci] generate new docs 2022-03-26 22:26:10 +00:00
emmyLuaDocs docs: [ci] generate new docs 2022-03-26 22:26:10 +00:00
gallery docs: update image for readme gallery 2022-03-22 21:19:36 -04:00
golibs docs(fs): change bool to boolean 2022-02-25 18:17:04 -04:00
libs chore: update lunacolors 2022-03-13 16:37:33 -04:00
prelude docs(guide): mention that users can copy the default dir from dataDir 2022-03-19 09:50:51 -04:00
readline feat: add inline hint text and change what were hints previously to info (closes #126) 2022-03-26 17:34:09 -04:00
util fix: only add __docProp metatable from SetField function 2021-11-22 19:19:36 -05: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 chore: prepare for v1.2.0 release 2022-03-22 22:11:46 -04:00
CONTRIBUTING.md docs: bring contributing guide up to date 2022-02-25 18:22:59 -04:00
LICENSE chore: update license 2022-02-12 16:46:41 -04:00
Makefile build: update makefile 2022-03-06 15:12:10 -04:00
README.md docs: change short description back to block quote 2022-03-22 22:04:33 -04:00
aliases.go refactor: rename hilbishAliases to aliasHandler for clarity 2022-03-19 12:43:48 -04:00
api.go feat: expose syntax highlighting (closes #125) 2022-03-26 18:25:19 -04:00
complete.go fix: completions of executables and running absolute paths on windows 2022-03-17 20:22:30 -04:00
exec.go fix: handle job being nil (first sh exec case) 2022-03-21 21:25:43 -04:00
execfile_unix.go fix: completions of executables and running absolute paths on windows 2022-03-17 20:22:30 -04:00
execfile_windows.go fix: completions of executables and running absolute paths on windows 2022-03-17 20:22:30 -04:00
go.mod chore: bring readline in repo for easier maintenance 2022-03-13 13:48:49 -04:00
go.sum chore: update dependencies 2022-03-06 10:07:28 -04:00
history.go feat: make history clear function work again 2022-03-22 19:01:29 -04:00
job.go feat: add hilbish.jobs interface and add stop function to job in hooks (closes #109) 2022-03-20 19:10:12 -04:00
lua.go refactor!: change preload.lua to prelude/init.lua, add guide command 2022-03-06 14:45:06 -04:00
main.go fix: make sure complete input is added to history 2022-03-19 18:48:03 -04:00
rl.go feat: expose syntax highlighting (closes #125) 2022-03-26 18:25:19 -04:00
runnermode.go feat: add configurable runner mode (closes #110) 2022-03-20 15:15:44 -04:00
signal_unix.go fix: catch and ignore sigquit signal (closes #112) 2022-03-14 20:55:00 -04:00
signal_windows.go fix: only notify ctrl c signal on windows 2022-02-28 16:15:08 -04:00
vars.go chore: prepare for v1.2.0 release 2022-03-22 22:11:46 -04:00
vars_darwin.go refactor!: change preload.lua to prelude/init.lua, add guide command 2022-03-06 14:45:06 -04:00
vars_linux.go refactor!: change preload.lua to prelude/init.lua, add guide command 2022-03-06 14:45:06 -04:00
vars_windows.go refactor!: change preload.lua to prelude/init.lua, add guide command 2022-03-06 14:45:06 -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 Hilish 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