Skip to content
WELD 0.1.2
Menu

Install#

This page gets you a working copy of WELD: what it needs, the two ways to get it, and how to verify the result.

Requirements#

  • PHP ^8.3
  • Laravel ^13.29
  • Node, for npm ci
  • Docker, for the local stack

Get it#

WELD is an app you start from, not a library you require. The Megazord ships in a repo, not a box. Composer makes you a fresh copy, writes .env, generates the app key and runs the first migration:

composer create-project waynestate/weld my-app
cd my-app
npm ci

Or clone it, if you want the history too, and it is yours to rename:

git clone https://github.com/waynestate/weld.git my-app
cd my-app
composer install
php vendor/bin/advisor install --client=claude --write
npm ci
# Windows (PowerShell):
Copy-Item .env.example .env
# Linux/macOS:
cp .env.example .env
php artisan key:generate

Verify#

Run the checks the way CI does. composer ci is the CI contract: it runs validate, tests, Pint, PHPStan level 8, the agent-ready check and audit, the same command on GitLab and GitHub. The test subcommand runs it in the app container: .\bin\weld.ps1 test on Windows (PowerShell), bin/weld.sh test on macOS / Linux.

The doctor strikes an arc across the local setup: .\bin\weld.ps1 doctor on Windows (PowerShell), bin/weld.sh doctor on macOS / Linux. It reports one line per check, PASS or WARN or FAIL, and exits with code 1 when anything FAILs, so it works as a gate. A good bead is a quiet one: all PASS and nothing to say.

Next steps#