boiler

Boiler is a highly opinionated CLI tool for creating and updating boilerplate files for your projects. It is capable of automatically detecting various different metadata from the project files, such as the programming languages used, frameworks, and even specific features of git, and then generating the boilerplate files based on that information. The boilerplate includes, but is not limited to, CI pipelines, pre-commit hooks, and configuration files.

Building

The project is written in Rust and uses Cargo build system.

cargo build --release

Running

Simply run the binary in the root directory of your project. It will automatically detect the project type and generate the boilerplate files in the current directory.

For more information, run boiler --help.

Developing

pre-commit

We encourage contributors to use predefined pre-commit hooks — to install them in your local repo, make sure you have pre-commit installed and run

pre-commit install