---
title: "Squire | Squire docs"
description: "Squire is the Citadel kit: the standard build.sh, release script and health check, and local parity on the real Citadel images."
url: https://squire.apps.wayne.edu/docs/
llms: https://squire.apps.wayne.edu/llms.txt
generator: Squire agent-ready
---

# Overview [#](https://squire.apps.wayne.edu/docs/#overview)

Squire is the Citadel kit: the standard `build.sh`, the release script, the health check, and a local setup that runs your app on the real Citadel images, behind a proxy like Citadel's. The next step is [installing it](https://squire.apps.wayne.edu/docs/install.html), which takes a minute and ends with a doctor check.

## What it does [#](https://squire.apps.wayne.edu/docs/#what-it-does)

- `squire init` writes the scripts a Citadel app needs from templates, for raw PHP, Laravel or a static site, and detects a Vue/Inertia layer from `package.json`, adding the layer's release script and Node 22 parity service. `squire init --check` reports when your copies have drifted from the templates (depend, do not copy). In a directory below the repository root (a `deploy/` layer, say), `init` also keeps the `.gitignore` honest: it appends `/vendor/`, `.env` and `.env.squire` when they are missing, never touches a line the app added, and leaves the repository root's `.gitignore` to the app.
- `squire update` takes the new template versions for the files you never edited, writes the template files a newer release added to a group the kit records (recording them in `.squire.json`), and shows a diff for the ones you did. It never overwrites your edits, and it runs the same in CI and on a laptop.
- `squire doctor` checks an app against the best practices a machine can decide. The lock file, composer audit and MySQL 5.6 checks are owned by PROCTOR; `doctor` hands off to it (S50) instead of repeating them.
- A local setup that runs your app on the Citadel PHP image, behind a proxy like Citadel's, with the same MySQL 5.6.
- Squire's maintainers send platform improvement proposals to the platform team privately. Squire never touches a server.

## Where the code lives [#](https://squire.apps.wayne.edu/docs/#where-the-code-lives)

The canonical repository is [git.wayne.edu/enterprise-apps/squire](https://git.wayne.edu/enterprise-apps/squire); clone it over SSH as `git@git.wayne.edu:enterprise-apps/squire.git` or over HTTPS as `https://git.wayne.edu/enterprise-apps/squire.git`. Open issues and merge requests there; tags are cut there, by a maintainer, with an approver. GitHub ([waynestate/squire](https://github.com/waynestate/squire)) is a read-only push mirror of it: Packagist reads from it, and nobody pushes to it. Your squire serves one banner, and it flies over git.wayne.edu.

## Its place in the stack [#](https://squire.apps.wayne.edu/docs/#its-place-in-the-stack)

Squire is part of WELD, the Wayne State application stack, beside WayneUI (project 0, the interface layer every other project builds on), CREED, PROCTOR, Preflight, SESAME, HELMET, Pinstripe, Sourdough, [Parity](https://parity.apps.wayne.edu/), Booster, Rollcall, Drawbridge and ADVISOR. Squire gets the app onto Citadel; Parity runs Citadel on your computer.

> A knight never suits up alone. Your app shouldn't deploy alone either.
