Skip to content
Menu

Install#

Requirements#

PHP ^8.3, tested on 8.3, 8.4 and 8.5. The package runs on your machine or in CI, not on Citadel; what lands on Citadel is the scripts it wrote.

Install#

composer require waynestate/squire --dev
vendor/bin/squire init
vendor/bin/squire doctor

Verify#

vendor/bin/squire doctor checks the app against the best practices a machine can decide. Exit codes: 0 pass, 1 findings (init --check: drift; update: an edited file still differs from the template; doctor: a failed rule), 2 the tool itself could not run.

Next: the command reference.