Skip to content

Commit b0e500d

Browse files
committed
Rewrite troubleshooting docs
1 parent 08bd25e commit b0e500d

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

docs/sandbox-cli.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -458,27 +458,29 @@ customisations/
458458

459459
## Troubleshooting
460460

461-
If QuickInstall is not working as expected, start with the environment check:
461+
If QuickInstall starts but a command is not working as expected, run the environment check from the project root:
462462

463463
```bash
464464
php bin/qi doctor
465465
```
466466

467-
Every check should report `OK`; failures include the detected problem. On Windows, use `.\bin\qi.cmd doctor` from PowerShell or `bin\qi.cmd doctor` from Command Prompt.
468-
469-
#### Command is not found on Windows
470-
471-
Run QuickInstall from the project root with the supplied Windows launcher:
467+
On Windows PowerShell, you can use the Windows launcher instead:
472468

473469
```powershell
474-
.\bin\qi.cmd help
470+
.\bin\qi.cmd doctor
475471
```
476472

477-
```batch
478-
bin\qi.cmd help
473+
Every check should report `OK`; failures identify the missing or unavailable requirement.
474+
475+
#### QuickInstall does not start on Windows
476+
477+
First, check whether PHP is available:
478+
479+
```powershell
480+
php --version
479481
```
480482

481-
If the launcher reports that QuickInstall requires PHP, install PHP 8 or newer and add the directory containing `php.exe` to the Windows `PATH`. Open a new terminal and run `php --version` to confirm it is available.
483+
If Windows does not recognize `php`, install PHP 8 or newer and add the directory containing `php.exe` to the Windows `PATH`. Open a new terminal, confirm `php --version` works, then run `.\bin\qi.cmd doctor` again.
482484

483485
#### Docker command fails
484486

0 commit comments

Comments
 (0)