Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@

</div>

A shell compiler that converts shell scripts into secure, portable and static binaries. Unlike other tools (ie. [shc](https://github.com/neurobin/shc)), Bunster does not just wrap your script within a binary. It literally compiles them to standalone shell-independent programs.
A shell compiler that converts shell scripts into secure, portable, and static binaries. Unlike other tools (i.e. [shc](https://github.com/neurobin/shc)), Bunster does not just wrap your script within a binary. It literally compiles them to standalone shell-independent programs.

Under the hood, **Bunster** transpiles shell scripts into [Go](https://go.dev) code. Then uses the [Go Toolchain](https://go.dev/dl) to compile the code to an executable.
Under the hood, **Bunster** transpiles shell scripts into [Go](https://go.dev) code. Then it uses the [Go Toolchain](https://go.dev/dl) to compile the code to an executable.

**Bunster** aims to be compatible with `bash` as a starting move. Expecting that most `bash` scripts will just work with bunster. Additional shells will be supported as soon as we release v1.
**Bunster** aims to be compatible with `bash` as a starting move. Expect that most `bash` scripts will just work with bunster. Additional shells will be supported as soon as we release v1.

> [!WARNING]
> This project is in its early stages of development. [Only a subset of features are supported so far](https://bunster.netlify.app/features/simple-commands).
Expand All @@ -27,17 +27,17 @@ In addition to being compatible with bash. bunster offers a lot of additional fe

- **Static binaries**: scripts compiled with bunster are not just wrappers around your script, nor do they rely on any external shells on your system.

- **Modular**: unlike traditional shells scripts that are written in a single file. bunster offers a module system that allows you to distribute code across as many files as needed. [learn more](https://bunster.netlify.app/workspace/modules)
- **Modular**: unlike traditional shells scripts that are written in a single file, bunster offers a module system that allows you to distribute code across as many files as needed. [learn more](https://bunster.netlify.app/workspace/modules)

- **Package Manager**: bunster has a buitlin package manager that makes it easy to publish and consume modules as libraries. [learn more](https://bunster.netlify.app/workspace/modules)
- **Package Manager**: bunster has a builtin package manager that makes it easy to publish and consume modules as libraries. [learn more](https://bunster.netlify.app/workspace/modules)

- **Native `.env` files support**: `.env` files are nativily supported in bunster. Allowing you to load variables from `.env` files at runtime. [learn more](https://bunster.netlify.app/features/environment-files)
- **Native `.env` files support**: `.env` files are natively supported in bunster, allowing you to load variables from `.env` files at runtime. [learn more](https://bunster.netlify.app/features/environment-files)

- **Static assets embedding**: bunster allows you to embed files and directories within your compiled program at compile time. And use them as if they were normal files in the system at runtime. [learn more](https://bunster.netlify.app/features/embedding)
- **Static assets embedding**: bunster allows you to embed files and directories within your compiled program at compile time. Simply use them as if they were normal files in the system at runtime. [learn more](https://bunster.netlify.app/features/embedding)

- **Builtin flags parsing**: You no longer have to bother your self parsing flags manually. Just declare what flags you expect, and let bunster do the rest. [learn more](https://bunster.netlify.app/features/functions#flags)
- **Builtin flags parsing**: You no longer have to bother yourself parsing flags manually. Just declare the flags you expect, and let bunster do the rest. [learn more](https://bunster.netlify.app/features/functions#flags)

- **Static analysis**: bunster statically analizes your scripts and reports potential bugs at compile time. (_wip_)
- **Static analysis**: bunster statically analyzes your scripts and reports potential bugs at compile time. (_wip_)

## Get Started

Expand All @@ -47,13 +47,18 @@ In addition to being compatible with bash. bunster offers a lot of additional fe

## Installation

We have bash script that installs `bunster` and adds it to your `$PATH`.
We have a bash script that installs `bunster` and adds it to your `$PATH`.

```shell
curl -f https://bunster.netlify.app/install.sh | bash
```

The script will install bunster at `~/.local/bin/bunster` on linux. And `~/bin/bunster` on mac. If you want to install the binary system wide and make it accessible by all users.
The script will install bunster at:

- `~/.local/bin/bunster` on Linux, and
- `~/bin/bunster` on macOS.

If you want to install the binary system-wide, and make it accessible by all users:

```shell
curl -f https://bunster.netlify.app/install.sh | GLOBAL=1 bash
Expand All @@ -65,25 +70,33 @@ curl -f https://bunster.netlify.app/install.sh | GLOBAL=1 bash
brew install bunster
```

Checkout the [documentation](https://bunster.netlify.app/installation) for different ways of installation.
Checkout the [documentation](https://bunster.netlify.app/installation) for other ways to install bunster.

## Versioning

Bunster follows [SemVer](https://semver.org/) system for release versioning. On each minor release `v0.x.0`, you should expect adding new features, code optimization, and build improvements. On each patch release `v0.N.x`, you should expect bug fixes and/or other minor enhancements.
Bunster follows [SemVer](https://semver.org/) system for release versioning. On each minor release `v0.x.0`, you can expect adding new features, code optimization, and build improvements. On each patch release `v0.N.x`, you can expect bug fixes and/or other minor enhancements.

Once we reach the stable release `v1.0.0`, you must expect your bash scripts to be fully compatible with Bunster (there might be some caveats). All features mentioned above to be implemented unless the community agreed on skipping some of them.
Once we reach the stable release `v1.0.0`, you can expect your bash scripts to be fully compatible with bunster (there might be some caveats). All features mentioned above to be implemented unless the community agreed on skipping some of them.

Adding support for additional shells is not planned until our first stable release `v1`. All regarding contributions will remain open until then.

## Developers Guidline
## Developer Guidelines

If you are interested in this project and want to know more about its underlying implementation, or if you want to contribute back but you don't know where to start, [we have a brief article](https://bunster.netlify.app/developers) that explains everything you need to get your hands dirty. Things like:

- the project structure, packages, and their concerns
- how each component works and interacts with other components
- how to add new features
- how to improve existing features
- testing

If you are interested in this project and want to know more about it's underlying implementation. Or if you want to contribute back but you don't know where to start. [We have brief article](https://bunster.netlify.app/developers) that explains everything you need to get your hands dirty. Things like the project structure, packages and their concerns, how each component work and interact with other components, how to add new features, how to improve existing features, testing and anything else in this regard.
And anything else in this regard.

## Contributing

Thank you for considering contributing to the Bunster project! The contribution guide can be found in the [documentation](https://bunster.netlify.app/contributing).

This project is developed and maintained by the public community, which includes you. Anything in this repository is subject to criticism. Including features, the implementation, the code style, the way we manage code reviews, the documentation and anything else in this regard.
This project is developed and maintained by the public community (which includes _you_!). Anything in this repository is subject to criticism. This includes features, the implementation, the code style, the way we manage code reviews, the documentation, and anything else in this regard.

Hence, if you think that we're doing something wrong, or have a suggestion that can make this project better, please consider opening an issue.

Expand Down
Loading