https://github.com/Rosettea/Hilbish

🌓 The Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺 ✨
https://github.com/Rosettea/Hilbish

cli command-line go golang hilbish linux lua prompt sh shell

Last synced: 15 days ago
JSON representation

🌓 The Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺 ✨

• Host: GitHub
• URL: https://github.com/Rosettea/Hilbish
• Owner: Rosettea
• License: mit
• Created: 2021-03-19T14:26:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T17:09:49.000Z (about 2 months ago)
• Last Synced: 2024-09-16T21:07:59.798Z (about 2 months ago)
• Topics: cli, command-line, go, golang, hilbish, linux, lua, prompt, sh, shell
• Language: Go
• Homepage: https://rosettea.github.io/Hilbish/
• Size: 7.32 MB
• Stars: 499
• Watchers: 4
• Forks: 23
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> [!TIP]

> Check out [Hilbish: Midnight Edition](https://github.com/Rosettea/Hilbish/tree/midnight-edition) if you want to use C Lua, LuaJIT or anything related!






🌓 The Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺 ✨















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, and powerful enough for

those who need more.

The motivation for choosing Lua was that its simpler and better to use

than old shell scripts. It's fine for basic interactive shell uses,

and supports [both Lua and Sh interactively](https://rosettea.github.io/Hilbish/docs/features/runner-mode/).

That's the only place Hilbish can use traditional shell syntax though; 

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](https://rosettea.github.io/Hilbish/install/)

on the website for distributed binaries from GitHub or other package repositories.

Otherwise, continue reading for steps on compiling.

## Prerequisites

- [Go 1.22+](https://go.dev)

- [Task](https://taskfile.dev/installation/) (**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.  

```sh

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](CONTRIBUTING.md) as a guideline to doing so.

**Thanks to everyone below who's contributed!**  



  



*Made with [contributors-img](https://contrib.rocks).*

# License

Hilbish is licensed under the [MIT license](LICENSE).  

[Images and assets](assets/) are licensed under CC-BY-SA 4.0