Installation

Get Boiler up and running on your system in minutes.

Quick Install

The fastest way to install Boiler is using our installation script:

Windows (PowerShell)

iwr -useb https://boiler.iamabhinav.dev/install | iex

Linux / macOS

curl -fsSL https://boiler.iamabhinav.dev/install | sh

npm

npm install -g @boilercli/core

winget (Windows)

winget install boiler

Package Managers

You can install Boiler using npm:

npm install -g @boilercli/core

You can also use system package managers:

• Windows: winget install boiler
• macOS: brew install boiler (coming soon)
• Linux: apt install boiler (coming soon)

Manual Installation

Prerequisites

• Go 1.21 or higher (for building from source)
• Git (for cloning the repository)

Build from Source

Windows

# Clone the repository
git clone https://github.com/rishiyaduwanshi/boiler.git
cd boiler

# Build the binary
go build -o boiler.exe main.go

# Run the install script
.\scripts\install.ps1

Linux/macOS

# Clone the repository
git clone https://github.com/rishiyaduwanshi/boiler.git
cd boiler

# Build the binary
go build -o boiler main.go

# Run the install script
chmod +x scripts/install.sh
./scripts/install.sh

Download Binary

1. Download the latest release binary from the GitHub Releases page
2. Extract the archive
3. Move the binary to a directory in your PATH

Windows

# Move to a directory in PATH (example)
Move-Item boiler.exe C:\Windows\System32\

Linux/macOS

# Move to /usr/local/bin
sudo mv boiler /usr/local/bin/
chmod +x /usr/local/bin/boiler

Verify Installation

Check that Boiler is installed correctly:

bl version

You should see the version information displayed.

Next Steps

Boiler is ready to use! The store is automatically created when you store your first snippet or stack.

# Store your first snippet
bl store myfile.js

# Or use bl init to create config files (npm-init pattern)
bl init  # Interactive prompt to create boiler.config.json or snippet files

Check out the Quick Start guide to learn the basics!