Conversation
…res. Added details for `start` and `server` commands, updated Node.js version requirement to 22.18, and clarified data persistence behavior in `start` mode. Enhanced quickstart instructions and added information on command arguments.
…om 22.18 to 22.12 for accuracy.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request significantly improves the documentation for the Playground CLI by clarifying the differences between the new simplified
startcommand and the advancedservercommand, updating usage instructions, and providing more details on data persistence and configuration options. The documentation now better guides users on when and how to use each command, highlights automatic project mounting and persistence, and introduces new CLI arguments.Key documentation improvements:
Command Usage and Behavior
start(simplified, auto-detects project, persists sites, opens browser) andserver(advanced, full manual control) in the CLI overview.startfor most users, including examples of automatic project mounting and browser launching.startandserver, especially regarding auto-login, browser opening, and project mounting.Data Persistence
startandservermodes, including the location of persisted files and databases, and the effect of explicit mounts. [1] [2]--resetflag forstartmode, explaining how to reset the persisted site and how to manually clear data forservermode. [1] [2]CLI Arguments and Requirements
--experimental-unsafe-ide-integrationargument for Xdebug integration with VS Code and PhpStorm.startandservercommands, highlighting the dedicated--resetargument forstart.These changes make the CLI documentation more accurate, user-friendly, and up-to-date for both new and advanced users.