boiler

boiler is a CLI for uploading game builds to Steam via SteamCMD.

It generates VDF files, guides Steam login + Steam Guard flows, and gives you a repeatable login -> init -> push workflow without manual Steamworks UI steps.

Table of Contents

• Why boiler
• Install
• Simple Usage (Beginner Friendly)
• Command Quick Reference
• Command Details
• Project Config (.boiler.json)
• CI / Automation
• SteamCMD Behavior
• Security
• Development
• License

Why boiler

Uploading with raw SteamCMD usually means:

• hand-writing VDF files
• remembering the right command sequence
• re-checking paths and depot mappings every upload
• dealing with Steam Guard prompts manually

boiler handles this with:

• interactive project setup (boiler init)
• guided login (boiler login)
• one-command upload (boiler push)
• changed-depot detection (skip unchanged depots)
• doctor and status commands for preflight and diagnostics

Install

Global install:

npm install -g @frinky/boiler

Run without installing:

npx @frinky/boiler --help

Simple Usage (Beginner Friendly)

If this is your first Steam upload, follow this exactly.

1. Log in once

boiler login

What happens:

• you enter Steam credentials
• Steam Guard is handled interactively (email/app/mobile prompt)
• boiler stores only your username (not your password)

2. Create project config

From your game project folder:

boiler init

You will be prompted for:

• Steam App ID
• one or more Depot IDs
• content root folder(s) (for example ./build)
• include/exclude mapping rules

This creates .boiler.json in your project root.

3. Upload your build

boiler push

That is the full basic flow.

4. Optional: one-off folder override (single depot only)

boiler push ./dist

Use this only when your config has a single depot.

Command Quick Reference

Global options:

Command Details

boiler login

Interactive login:

boiler login

Non-interactive (CI/automation):

BOILER_USERNAME=buildbot \
BOILER_PASSWORD=super-secret \
boiler login --non-interactive

Supported automation inputs:

• --username <name>
• --password-env <var>
• --guard-code-env <var>
• --install-steamcmd
• --non-interactive
• BOILER_USERNAME
• BOILER_PASSWORD
• BOILER_GUARD_CODE
• BOILER_NON_INTERACTIVE=1

boiler init

Create or refresh project config:

boiler init

boiler push [folder]

Upload using .boiler.json:

boiler push

Examples:

# Single-depot folder override
boiler push ./build

# One-off upload without config
boiler push ./build --app 480 --depot 481

# Add a build description
boiler push ./build --desc "v1.2.0 release"

# Set a branch live after upload
boiler push ./build --set-live beta

# Preview VDF output without upload
boiler push ./build --dry-run

# Force all depots (skip changed-depot detection)
boiler push --all-depots

# Strict content hashing for change detection
boiler push --content-hash

# Download SteamCMD from Valve if needed
boiler push --install-steamcmd

Push flags:

Important behavior:

• If --desc is omitted, a timestamp-based description is generated.
• Transient SteamCMD failures are retried up to 3 times with exponential backoff.
• Changed-depot detection uploads only depots with changes unless --all-depots is set.
• Set BOILER_CONTENT_HASH=1 to enable strict content hashing by environment variable.
• For multi-depot configs, folder override is blocked to prevent accidental wrong uploads.
• boiler will not auto-download SteamCMD unless you explicitly pass --install-steamcmd.

boiler status

boiler status
boiler status --json

Shows:

• depot mapping summary
• output/artifact paths
• SteamCMD path detection
• saved username
• cached login state
• last upload details

boiler doctor

boiler doctor
boiler doctor --json
boiler doctor --json --strict

Checks:

• project config validity
• depot content roots
• SteamCMD availability
• saved username
• cached Steam login

boiler help [command]

boiler help
boiler help push

boiler (no args)

Running boiler with no args opens an interactive menu for login, init, push, status, and doctor.

Project Config (.boiler.json)

boiler init creates a .boiler.json like this:

{
  "appId": 480,
  "depots": [
    {
      "depotId": 481,
      "contentRoot": "./build",
      "fileMappings": [
        {
          "localPath": "*",
          "depotPath": ".",
          "recursive": true
        }
      ],
      "fileExclusions": ["*.pdb", "*.map", ".DS_Store", "Thumbs.db"]
    }
  ],
  "buildOutput": ".boiler-output",
  "setLive": null
}

Notes:

• This file is safe to commit.
• buildOutput is where generated VDFs and upload artifacts are written.
• setLive is used by default for push unless overridden by --set-live.
• Legacy configs with single fileMapping are still read, but new configs should use fileMappings.

If a depot needs multiple Steam FileMapping entries:

{
  "depotId": 481,
  "contentRoot": "./build",
  "fileMappings": [
    { "localPath": "*", "depotPath": ".", "recursive": true },
    { "localPath": "extras/*.dll", "depotPath": "./bin", "recursive": false }
  ],
  "fileExclusions": ["*.pdb"]
}

CI / Automation

Typical CI flow:

boiler doctor --json --strict
boiler login --non-interactive --install-steamcmd
boiler push

Recommended environment variables:

export BOILER_USERNAME=buildbot
export BOILER_PASSWORD=super-secret
export BOILER_NON_INTERACTIVE=1

If Steam Guard code entry is required in CI:

export BOILER_GUARD_CODE=123456

SteamCMD Behavior

boiler requires SteamCMD to upload builds.

If SteamCMD is not found, boiler stops by default and asks you to install it manually or rerun with --install-steamcmd. If SteamCMD is already installed, boiler checks your PATH, common install locations, and its own managed install directory.

Security

• Passwords are never stored by boiler.
• Only the Steam username is saved in global config.
• SteamCMD handles its own credential caching.
• For automation, use a dedicated Steam account instead of a personal account.

Global config location:

~/.boiler/config.json

Development

git clone https://github.com/your-username/boiler.git
cd boiler
npm install
npm run build
npm run dev -- --help
npm test

License

MIT