Commands#
The block below is owned by the docs builder: it lists every command the CLI keeps, with its usage, arguments and options, and is rewritten from the repository on every build.
| Command | What it does |
|---|---|
squire doctor |
Check an app's Citadel release setup against the Squire rules (S1 to S78). |
squire facts |
Fills the squire-facts regions from .squire/facts.json (--check: report drift, write nothing) |
squire init |
Write the standard Citadel scripts into an app, or report drift with --check. |
squire site |
Builds the docs site and agent-ready files from the pinned library tag, with a sha256 manifest |
squire update |
Take new template versions for files Squire wrote that were never edited, add the files a newer release wrote, and show a diff for the edited ones. |
squire doctor#
Check an app's Citadel release setup against the Squire rules (S1 to S78).
Usage: squire doctor [--path PATH] [--format FORMAT] [--] [<topic>]
| Argument | Required | Meaning |
|---|---|---|
topic |
no | Optional topic. Use oracle to check the Oracle connection settings. |
| Option | Meaning | Default |
|---|---|---|
--path=VALUE |
Path to the application. | . |
--format=VALUE |
Output format: text or json. | text |
--silent |
Do not output any message |
squire facts#
Fills the squire-facts regions from .squire/facts.json (--check: report drift, write nothing)
Usage: squire facts [--check] [--path PATH] [--snapshot] [--from FROM] [--today TODAY]
| Option | Meaning | Default |
|---|---|---|
--check |
Write nothing; report regions that are out of date. Exit 1 on drift. | |
--path=VALUE |
Path to the folder holding .squire/facts.json. | . |
--snapshot |
Rebuild .squire/facts.json from vendor/waynestate/creed and vendor/waynestate/advisor first | |
--from=VALUE |
The folder holding creed/ and advisor/ | |
--today=VALUE |
The date to stamp and to judge PHP support by; default today | |
--silent |
Do not output any message |
squire init#
Write the standard Citadel scripts into an app, or report drift with --check.
Usage: squire init [--path PATH] [--target TARGET] [--only ONLY] [--php PHP] [--check] [--force]
| Option | Meaning | Default |
|---|---|---|
--path=VALUE |
Path to the application. | . |
--target=VALUE |
raw, laravel or static (default: the target recorded in .squire.json, else laravel when an artisan file exists; static must be asked for). | |
--only=VALUE |
Comma-separated groups to write: release, parity (opt-in: Parity runs Citadel locally now). (default: the groups recorded in .squire.json, else release) | |
--php=VALUE |
Citadel PHP image line, such as 8.5r3 (default: the line in .squire.json, else 8.5r3 for a new app) | |
--check |
Write nothing; report files that are missing, outdated or edited. Exit 1 on drift. | |
--force |
Overwrite files that were edited or that Squire did not write. | |
--silent |
Do not output any message |
squire site#
Builds the docs site and agent-ready files from the pinned library tag, with a sha256 manifest
Usage: squire site [--root ROOT] [--pin PIN] [--out OUT] [--repo REPO] [--base BASE] [--check] [--] [<action>]
| Argument | Required | Meaning |
|---|---|---|
action |
no | The site action to run; build for now. |
| Option | Meaning | Default |
|---|---|---|
--root=VALUE |
Path to the site repository. | . |
--pin=VALUE |
The site pin, relative to --root. | site.json |
--out=VALUE |
The output folder, relative to --root. | public |
--repo=VALUE |
A local git repository of the library; when empty, vendor/waynestate/NAME under --root, NAME being the part of the library after the last slash. | |
--base=VALUE |
Accepted for a later remote fetch; unused for now. | |
--check |
Builds into a temp folder and compares it with the output folder, printing one line per finding and writing nothing. | |
--silent |
Do not output any message |
squire update#
Take new template versions for files Squire wrote that were never edited, add the files a newer release wrote, and show a diff for the edited ones.
Usage: squire update [--path PATH] [--target TARGET] [--only ONLY] [--dry-run]
| Option | Meaning | Default |
|---|---|---|
--path=VALUE |
Path to the application. | . |
--target=VALUE |
raw, laravel or static (default: the target recorded in .squire.json). | |
--only=VALUE |
Comma-separated groups to update: release, parity (opt-in: Parity runs Citadel locally now). (default: the groups recorded in .squire.json) | |
--dry-run |
Print the plan; write nothing. | |
--silent |
Do not output any message |
Options every command accepts#
| Option | Meaning | Default |
|---|---|---|
-h, --help |
Display help for the given command. When no command is given display help for the list command | |
-q, --quiet |
Only errors are displayed. All other output is suppressed | |
| `-v | -vv | -vvv, --verbose` |
-V, --version |
Display this application version | |
--ansi |
Force (or disable --no-ansi) ANSI output | |
--no-ansi |
Negate the "--ansi" option | |
-n, --no-interaction |
Do not ask any interactive question |
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.
The parity group is deprecated#
When the parity group is in play, init (not init --check) and update print one line before they finish, and doctor adds an S35 info finding that says the same: the group is deprecated, it is removed no sooner than Squire 0.12.0, and Parity runs Citadel on your computer now (parity init --from-squire carries the kit over). The exit codes do not change. See Local parity.
doctor oracle#
vendor/bin/squire doctor oracle runs the same plain-language Oracle connection check that release.sh runs on Citadel, from your terminal or sail php vendor/bin/squire doctor oracle. It reads the ORACLE_* settings from the environment and the app's .env, prints setting names and never values, and stays silent when the app has no Oracle settings. Add -v for the client version.