# Booster

> Booster plans and runs PHP and Laravel upgrades one hop at a time on Rector, gates every hop with your tests on the target PHP, and never commits or pushes for you.

**Boosts your versions.** One dose at a time, and every dose gets a stamp.

**Not to be confused with:** Booster moves an app to a newer PHP or framework version; Pinstripe's Rector set only modernizes code within the PHP version the app already runs.

Checks: `composer ci` (the same command runs on GitLab and GitHub).

Documentation: the docs live at [booster.apps.wayne.edu/docs/](https://booster.apps.wayne.edu/docs/) and are built from `docs/` by `bin/docs-site.php`.

Every page below is Markdown. The HTML pages send the same Markdown to a client that asks for `text/markdown`. Written by Squire's agent-ready kit from the README and the pages; do not edit.

## Pages

- [Booster: Boosts your versions.](https://booster.apps.wayne.edu/index.md): Booster plans and runs PHP and Laravel upgrades one hop at a time on Rector, gates every hop with your tests on the target PHP, and never commits or pushes for you.
- [Checks | Booster docs](https://booster.apps.wayne.edu/docs/checks.md): How Booster is built, tested and released, and where its proof lives.
- [The baseline | Booster docs](https://booster.apps.wayne.edu/docs/guides/baseline.md): The test run that separates a bad hop from a suite that was already red.
- [Behavior changes | Booster docs](https://booster.apps.wayne.edu/docs/guides/behaviour-changes.md): The silent changes between versions that Rector does not rewrite, one block per hop.
- [Deploying on Citadel | Booster docs](https://booster.apps.wayne.edu/docs/guides/citadel.md): The deployment script Booster writes when a real run changes composer.lock.
- [The dependency check | Booster docs](https://booster.apps.wayne.edu/docs/guides/dependency-check.md): How Booster asks Packagist whether your direct dependencies can follow the plan.
- [What a hop does | Booster docs](https://booster.apps.wayne.edu/docs/guides/hops.md): What happens inside one hop, from the Rector dry run to the gate.
- [Laravel hops and vendor/ | Booster docs](https://booster.apps.wayne.edu/docs/guides/laravel-and-vendor.md): Why Laravel hops need the app's vendor folder, and where the hop data comes from.
- [Quick start | Booster docs](https://booster.apps.wayne.edu/docs/guides/quick-start.md): The first commands to run, and what a plan looks like.
- [The scans | Booster docs](https://booster.apps.wayne.edu/docs/guides/scans.md): The two advisory scans Booster runs, and how to run either one alone.
- [A smoke test for WSU apps | Booster docs](https://booster.apps.wayne.edu/docs/guides/smoke-test.md): One small test that proves the app boots and its front door still sends guests to CAS.
- [Booster | Booster docs](https://booster.apps.wayne.edu/docs/index.md): What Booster is, and the first command to run on your app today.
- [Install | Booster docs](https://booster.apps.wayne.edu/docs/install.md): Every route to get Booster running, from a single file to Docker only.
- [Next | Booster docs](https://booster.apps.wayne.edu/docs/next.md): What Booster does not do yet, and what it decided not to build.
- [How do I... | Booster docs](https://booster.apps.wayne.edu/docs/recipes.md): Recipes for the situations people actually ask about, with the exact command, what Booster does, and when not to use it.
- [Commands | Booster docs](https://booster.apps.wayne.edu/docs/reference/commands.md): Every Booster command and option, generated from the tool itself.
- [Configuration | Booster docs](https://booster.apps.wayne.edu/docs/reference/configuration.md): The environment variables Booster reads, and where it gets the policy.
- [Hops | Booster docs](https://booster.apps.wayne.edu/docs/reference/hops.md): Every hop Booster knows, generated from the hop data.
- [BOOSTER proof: real output](https://booster.apps.wayne.edu/proof.md): Booster plans and runs PHP and Laravel upgrades one hop at a time on Rector, gates every hop with your tests on the target PHP, and never commits or pushes for you.

## Prompts

- [Get started with Booster](https://booster.apps.wayne.edu/#prompt-get-started): Clones Booster next to your app, runs detect and plan, and reports back. Nothing in your app changes. The prompt itself is in https://booster.apps.wayne.edu/index.md.
- [Upgrade a raw PHP app](https://booster.apps.wayne.edu/#prompt-raw-php): Plans the PHP hops, scans for what will break and does a dry run. The real run waits until you say so. The prompt itself is in https://booster.apps.wayne.edu/index.md.
- [Upgrade a raw PHP app with a Vue front end](https://booster.apps.wayne.edu/#prompt-raw-php-vue): Plans the PHP hops and the Node pin, and stages the Vue 2 to 3 move: the compat build, then the codemod, with a person doing the Vue work. The prompt itself is in https://booster.apps.wayne.edu/index.md.
- [Upgrade a Laravel app with Blade](https://booster.apps.wayne.edu/#prompt-laravel-blade): Laravel and PHP hops in the order that keeps a supported pair at every step, and SESAME if the app still signs in with wayne-cas. The prompt itself is in https://booster.apps.wayne.edu/index.md.
- [Upgrade a Laravel app with Vue islands](https://booster.apps.wayne.edu/#prompt-laravel-blade-vue): The Laravel and PHP hops, the Node pin, and Mix to Vite when the plan lands on Laravel 9 or newer. The prompt itself is in https://booster.apps.wayne.edu/index.md.
- [Upgrade a Laravel app with Inertia](https://booster.apps.wayne.edu/#prompt-laravel-inertia-vue): The Laravel and PHP hops and the Node pin, with the Inertia checks a person still does by hand. The prompt itself is in https://booster.apps.wayne.edu/index.md.

## Source

- [README](https://nougat.snu.gs/enterprise-apps/booster/blob/HEAD/README.md): the project's README, with install, commands and checks
- [Everything in one file](https://booster.apps.wayne.edu/llms-full.txt): the README and every page above, as one Markdown file

## Optional

- [ADVISOR](https://advisor.apps.wayne.edu/llms.txt): the stack's MCP server: read-only tools that answer from CREED's policy and the parts' docs instead of from memory
- [WELD](https://weld.apps.wayne.edu/llms.txt): the Wayne State application stack: every part, and the reference app