[Documentation] Adding Playground CLI page and removing wp-now references #2337
Conversation
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
fellyph changed the title fellyph changed the title 
adamziel reviewed Jul 8, 2025
| Some projects have a specific structure that requires a custom configuration, for example, your repo contains all the files from the `/wp-content/` folder. So this scenario you can specify to the Plaground CLI you will mount your project from that folder using the flag `--mount`. | ||
| | ||
| ```bash | ||
| npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/ |
There was a problem hiding this comment.
Nice! Just noticing we'll need to coordinate updating this with merging #2281 as that will break some CLI BC.
adamziel reviewed Jul 8, 2025
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
adamziel reviewed Jul 8, 2025
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Show resolved Hide resolved
| Nice! Thank you @fellyph. Good direction, I've just left some notes. Btw, are we duplicating the CLI readme with that page? I wonder if there's a way to symlink one to the other perhaps? Or would you say they're distinct? |
bgrgicak reviewed Jul 11, 2025
packages/docs/site/docs/developers/05-local-development/01-wp-now.md Outdated Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved
| On Windows, the path format `/host/path:/vfs/path` can cause issues. To resolve this, use the flags `--mount-dir` and `--mount-dir-before-install`. These flags let you specify host and virtual file system paths in an alternative format`"/host/path"` `"/vfs/path"`. | ||
| ::: | ||
| | ||
| ## Command and Arguments |
There was a problem hiding this comment.
Is there something in Docusaurus that would enable us to auto-generate this section? I'm concerned about it getting outdated.
…now.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
Co-authored-by: Bero <berislav.grgicak@gmail.com>
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
| It seems like there are some build failures |
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
…playground-cli.md Co-authored-by: Bero <berislav.grgicak@gmail.com>
| @adamziel I have updated the branch, let's see if the CI passes now. |
| It seems like there's still a missing image error |
| When I go to the build job failure details and scroll all the way down, the error says: The relative path used in |
| I have fixed the image address and fixed the issue. |
| I have removed  |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Motivation for the change, related issues
Due to the deprecation of the
wp-nowand the rollout of the new playground CLI(#2224). This pull request updates the references fromwp-nowto@wp-playground/cliand creates a new page showing how to use the new playground CLI.Implementation details
wp-nowpageTesting Instructions (or ideally a Blueprint)
adding-playground-cli-pagenpm run dev:docs