Installation

By default, Bunster is an independent utility that you can install and start using right away. However, Bunster does assume that you have the Go toolchain installed and accessbile in PATH.

We rely on gofmt provided by the the Go toolchain to format the generated code. This makes it easy to debug and/or to learn from. Additionally, We use the Go compiler to compile the code and generate the executable for you.

INFO

The absence of the Go toolchain does not affect the working of Bunster. It's still going to work just fine. If you only care about the generated Go code, and don't want Bunster to automatically compile the exectuable for you. That is totally fine and you can go for it.

Linux/Mac

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

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.

curl -f https://bunster.netlify.app/install.sh | GLOBAL=1 bash

Homebrew

brew install bunster

Docker Image

The easiest way to get Bunster is through our official Docker Image. It comes with everything needed. Including the Bunster compiler and the Go toolchain.

docker pull ghcr.io/yassinebenaid/bunster:latest

Or, if you want a specific version (v.0.3.0 for example):

docker pull ghcr.io/yassinebenaid/bunster:v0.3.0

Github Release

You can get the latest version of bunster from github releases.

WARNING

Only linux and macos binaries are available at the moment. windows support is coming soon.

Using Go

If you already have the Go toolchain installed. You can use the go install command to get Bunster on your machine.

go install github.com/yassinebenaid/bunster/cmd/bunster@latest

Or, if you want a specific version (v.0.3.0 for example):

go install github.com/yassinebenaid/bunster/cmd/bunster@v0.3.0

This will build the binary at $HOME/go/bin/bunster, if you want to make it accessible by all users, you can move it to /usr/local/bin

mv $HOME/go/bin/bunster /usr/local/bin # you may need to use `sudo`.

INFO

If you choose to install using go install. make sure that $HOME/go/bin is added to your PATH. If not yet, Please add export PATH=$PATH:$HOME/go/bin to one of your profile files. eg. ~/.bashrc if you're using bash, or ~/.zshrc if you're using zsh.

Nixpkgs (NixOS & Nix)

If you use Nix, you can install Bunster from the unstable branch of nixpkgs:

NixOS Config

Add the following Nix code to your NixOS Configuration, usually located in /etc/nixos/configuration.nix

  environment.systemPackages = [
    pkgs.bunster
  ];

Nix Shell

A nix-shell will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it.

nix-shell -p bunster

Nix Env (not recommended)

On NixOS

nix-env -iA nixos.bunster

On Non-NixOS

# without flakes:
nix-env -iA nixpkgs.bunster
# with flakes:
nix profile install nixpkgs#bunster

> **Bunster** is currently only available in the `unstable` branch of Nixpkgs but will be coming to the `stable` branch soon.