Boiler

A project template manager for developers.

Boiler helps you create, store, manage, and reuse project templates directly from your terminal. Stop setting up the same project structure repeatedly — create a template once and reuse it whenever you need it.

██████╗  ██████╗ ██╗██╗     ███████╗██████╗
██╔══██╗██╔═══██╗██║██║     ██╔════╝██╔══██╗
██████╔╝██║   ██║██║██║     █████╗  ██████╔╝
██╔══██╗██║   ██║██║██║     ██╔══╝  ██╔══██╗
██████╔╝╚██████╔╝██║███████╗███████╗██║  ██║
╚═════╝  ╚═════╝ ╚═╝╚══════╝╚══════╝╚═╝  ╚═╝

Current version: 0.0.1 (beta)

Features

• Template management — Create, list, use, and remove project templates.
• Quick project initialization — Set up a project using a saved template.
• Add existing files — Add files and directories to a template.
• Template selection — Select a template to work with.
• Command-line interface — Manage everything directly from your terminal.
• Configurable appearance — Customize the banner, colors, and other settings through boiler.cfg.
• Windows executable — Run Boiler from your terminal after installation.

Installation

Windows installer

1. Download the Boiler installer from the project's GitHub Releases page.
2. Run the installer.
3. Follow the installation instructions.
4. Open a new PowerShell or Command Prompt window.

Verify the installation:

boiler -v

Display the available commands:

boiler -h

Note: The installer should add Boiler's installation directory to your system PATH. Open a new terminal after installation so Windows can recognize the updated environment.

Getting started

1. Create a template

Create a template with your desired name:

boiler boil -n <NAME>

2. Add files to a template

Add a file or directory to a template:

boiler add <FILE> -n <NAME>

You can also add a directory:

boiler add <DIRECTORY> -n <NAME>

Or add multiple files or directories:

boiler add . -n <NAME>

The -n or --name option specifies the template to modify. If the command supports selecting a template through another mechanism, select the appropriate template first.

You can also set a current template so you don't have to specify its name repeatedly:

boiler set -n <NAME>

By default, Boiler automatically sets a newly created template as the current template.

3. List your templates

boiler list

Example output:

1. pygame
2. template1
3. flask

4. Initialize a project

Use a saved template to create a project in your current working directory:

boiler init -n <NAME>

Follow any prompts to select a template, if required.

5. Remove a template

boiler remove -n <NAME>

To remove all templates:

boiler remove -a

Boiler may ask for confirmation before deleting templates. Bulk removal is destructive, so make sure you have backups of any important data before confirming.

Commands

Options

To view the syntax supported by your installed version, run:

boiler -h

Configuration

Boiler uses a boiler.cfg configuration file.

Example:

name=Boiler
version=0.0.1
versionType=beta
description=Project template manager for developers
author=MrPsyghost
license=MIT
asciiFont=ANSI_Shadow
color=light_yellow
showBanner=true

The configuration file is distributed with the application. User-specific templates and mutable settings should be stored in the user's application data directory rather than in the protected installation directory.

Development

Want to contribute to Boiler or build it from source? Follow the instructions below.

Requirements

• Python
• GNU Make (optional; you can also build the project manually)
• PyInstaller
• Inno Setup 6 (to compile the Windows installer)

Set up the project

Clone the repository:

git clone https://github.com/MrPsyghost/Boiler.git
cd Boiler

Create and activate a virtual environment:

python -m venv .venv
.\.venv\Scripts\Activate.ps1

Install the required dependencies using the project's dependency file.

Build the executable

make build

The executable should be generated at:

dist/boiler.exe

Build the installer

After building the executable, make sure Inno Setup 6 is installed and correctly configured.

Run:

make installer

If your Makefile defines a combined release target, you can build the executable and installer in one go:

make release

The installer's output directory and filename are configured in compiler.iss.

Project structure

A simplified view of the project:

Boiler/
├── src/
│   ├── main.py
│   ├── boiler.cfg
│   ├── boiler.ico
│   └── ...
├── compiler.iss
├── Makefile
├── README.md
└── dist/
    ├── boiler-setup-v(VERSION)-(VERSION-TYPE).exe
    ├── boiler.exe
    └── boiler.cfg

The exact project structure may vary as development continues.

Roadmap

Boiler is currently in beta. Potential future improvements include:

• Improved template management and selection.
• More robust error handling during file operations.
• Better cross-platform support.
• Additional configuration options.
• A smoother release and update workflow.

Issues and feedback

Found a bug or have an idea for a new feature?

Open an issue on the Boiler GitHub repository.

Please include the command you ran, the expected behavior, the actual behavior, and any relevant error messages.

License

Boiler is released under the MIT License.

See the LICENSE file for the full license text.

Author

MrPsyghost

• Portfolio: MrPsyghost Portfolio
• GitHub: MrPsyghost GitHub

---

Build once. Reuse everywhere. Stay productive with Boiler.