Boilr

Boilr usage

Download a release from the release page matching your architecture. Then follow the instructions below.

Notes

this is a fork of the fork of the original project, to get a build pipeline that creates binary version to download and use for Windows, Mac (M1/M2/Intel) and Linux (32 bit and 64 bit).

Installation

Binaries for Windows, Linux and OSX are built automatically by the giltab-ci every release.

To get the newest release for your system, the latest release can be found under https://gitlab.ost.ch/ifs/boilr/-/releases/permalink/latest

All the available releases can be found under the releases tab of the repo

Windows

FIXME: Installation is currently not straight-forward.

1. Go to the latest release page
2. download the windows binary (most likely the boilr-windows-amd64.exe)
3. Use it with your commandline.

OSX

FIXME: Unsure what OSX needs.

1. Go to the latest release page
2. download the OSX binary (M1/M2 and Intel 64-bit)
3. Use it with your commandline.

Linux

To get the newest release you can run the following commands (change to amd64 to 386 if needed):

Latest

rm -f ~/bin/boilr
wget -O boilr https://gitlab.ost.ch/ifs/boilr/-/releases/permalink/latest/downloads/binaries/boilr-linux-amd64
install boilr ~/bin/boilr
# or, if system wide installation is preferred:
# sudo rm -f /usr/bin/boilr
# sudo install boilr /usr/bin/boilr
rm boilr
# test
boilr version

Specific Version

Example with Version 0.3.5:

rm -f ~/bin/boilr
wget -O boilr https://gitlab.ost.ch/ifs/boilr/-/releases/0.3.5/downloads/binaries/boilr-linux-amd64
install boilr ~/bin/boilr
# or, if system wide installation is preferred:
# sudo install boilr /usr/bin/boilr
rm boilr

Initialisation

Execute boilr init (on Windows boilr.exe init).

Usage

See below.

Information From Fork of the Fork - may be out of date

Are you doing the same steps over and over again every time you start a new programming project?

Boilr is here to help you create projects from boilerplate templates.

For more details, see Introduction page.

Features

• No dependencies (NodeJS, Python Interpreter etc.) - Boilr is a single statically linked binary. Grab the one that fits your architecture, and you're all set to save time by using templates!
• Full Power of Golang Templates - Golang has powerful templating constructs which are very easy to learn and powerful.
• Dead-Simple Template Creation - Creating boilerplate templates are very easy, check out the license template to see a simple, but very useful template for adding licenses to new projects with a single command.

Getting Started with Boilr

Use boilr help to get the list of available commands.

Download a Template

In order to download a template from a github repository, use the following command:

boilr template download <github-repo-path> <template-tag>
boilr template download tmrts/boilr-license license

The downloaded template will be saved to local boilr registry.

Save a Local Template

In order to save a template from filesystem to the template registry use the following command:

boilr template save <template-path> <template-tag>
boilr template save ~/boilr-license license

The saved template will be saved to local boilr registry.

Use a Template

For a Boilr template with the given directory structure:

.
├── project.json
├── README.md
└── template
    └── LICENSE

And the following project.json context file:

{
    "Author": "Tamer Tas",
    "Year": "2015",
    "License": [
        "Apache Software License 2.0",
        "MIT",
        "GNU GPL v3.0"
    ]
}

When using the template with the following command:

boilr template use <template-tag> <target-dir>
boilr template use license /workspace/tmrts/example-project/

The user will be prompted as follows:

[?] Please choose an option for "License"
    1 -  "Apache Software License 2.0"
    2 -  "MIT"
    3 -  "GNU GPL v3.0"
    Select from 1..3 [default: 1]: 2
[?] Please choose a value for "Year" [default: "2015"]:
[?] Please choose a value for "Author" [default: "Tamer Tas"]:
[✔] Created /workspace/tmrts/example-project/LICENSE
[✔] Successfully executed the project template license in /workspace/tmrts/example-project

For more information please take a look at Usage and Creating Templates pages in the wiki.

List of Templates

Take a look at the Templates page for an index of project templates, examples, and more information.

Need Help? Found a bug? Want a Feature?

If you'd like to contribute, share your opinions or ask questions, please feel free to open an issue.

At this stage, user feedback is of utmost importance, every contribution is welcome however small it may be.