Skip to content

[docs] Adding cli start command#3239

Merged
brandonpayton merged 7 commits intotrunkfrom
adding-cli-start
Mar 3, 2026
Merged

[docs] Adding cli start command#3239
brandonpayton merged 7 commits intotrunkfrom
adding-cli-start

Conversation

@fellyph
Copy link
Collaborator

@fellyph fellyph commented Feb 3, 2026

This pull request significantly improves the documentation for the Playground CLI by clarifying the differences between the new simplified start command and the advanced server command, 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

  • Added a clear explanation of the two main commands, start (simplified, auto-detects project, persists sites, opens browser) and server (advanced, full manual control) in the CLI overview.
  • Updated the Quickstart and usage instructions to recommend start for most users, including examples of automatic project mounting and browser launching.
  • Clarified the behavioral differences between start and server, especially regarding auto-login, browser opening, and project mounting.

Data Persistence

  • Added detailed documentation on how data persistence works in both start and server modes, including the location of persisted files and databases, and the effect of explicit mounts. [1] [2]
  • Documented the --reset flag for start mode, explaining how to reset the persisted site and how to manually clear data for server mode. [1] [2]

CLI Arguments and Requirements

  • Added documentation for the new --experimental-unsafe-ide-integration argument for Xdebug integration with VS Code and PhpStorm.
  • Clarified available arguments for both start and server commands, highlighting the dedicated --reset argument for start.

These changes make the CLI documentation more accurate, user-friendly, and up-to-date for both new and advanced users.

…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.
@fellyph fellyph marked this pull request as ready for review February 17, 2026 10:19
Copilot AI review requested due to automatic review settings February 17, 2026 10:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Playground CLI docs to clarify the new simplified start command vs the advanced server command, including persistence behavior and new arguments.

Changes:

  • Added a start vs server overview with updated Quickstart guidance.
  • Expanded documentation for persistence behavior (including --reset) and SQLite locations.
  • Documented the new --experimental-unsafe-ide-integration CLI argument.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

fellyph and others added 3 commits February 17, 2026 19:57
…playground-cli.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…playground-cli.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Member

@brandonpayton brandonpayton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fellyph thanks for these updates! I reviewed only the changes, not the surrounding text, but the changes look good to me.

@brandonpayton brandonpayton merged commit d61a81c into trunk Mar 3, 2026
44 checks passed
@brandonpayton brandonpayton deleted the adding-cli-start branch March 3, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants