From 52840ddf48677493e014ed1fb5f540e02b71a053 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:24:10 +0100 Subject: [PATCH 01/26] Adding new intro page --- .../developers/05-local-development/intro.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/packages/docs/site/docs/developers/05-local-development/intro.md b/packages/docs/site/docs/developers/05-local-development/intro.md index bc83bacbd8..dfe327ceb6 100644 --- a/packages/docs/site/docs/developers/05-local-development/intro.md +++ b/packages/docs/site/docs/developers/05-local-development/intro.md @@ -3,18 +3,17 @@ title: Local Development slug: /developers/local-development --- -## Local Development with WordPress Playground +## Local WordPress Development with Playground -Playground powers offers several development environments designed to streamline the process of setting up and managing WordPress sites. +Playground offers various development environments to streamline setting up and managing WordPress sites. -The easiest way to get WordPress site up and running is to open a [public Playground web instance](/web-instance) from https://playground.wordpress.net/ (you could also [host your own WordPress Playground](/developers/architecture/host-your-own-playground)). +For a quick start, use a [public Playground web instance](/web-instance) at https://playground.wordpress.net/. Alternatively, you can [host your own WordPress Playground](/developers/architecture/host-your-own-playground). -Playground provides additional tools to check your code on a local WordPress environment. These tools are designed to enhance the development experience by prioritizing ease of installation and usability: +Playground also provides tools for local WordPress development, prioritizing easy installation and usability: -- [`wp-now`](/developers/local-development/wp-now) - CLI tool to spin up a WordPress site with a single command +- **[@wp-playground/cli](/developers/local-development/wp-playground-cli):** A command-line tool to quickly launch a WordPress site from your terminal. +- **[Visual Studio Code Extension](/developers/local-development/vscode-extension):** Integrates WordPress development directly into VS Code for a seamless experience within the popular editor. -- [Visual Studio Code Extension](/developers/local-development/vscode-extension) - Integrates WordPress development directly into Visual Studio Code to get a seamless development experience within the popular code editor. +For those needing more control, Playground offers tools for Node.js: -But Playground also provides tools to use WordPress Playground in Node.js: - -- [WordPress Playground in Node.js](/developers/local-development/php-wasm-node) - If you need low-level control over the underlying WebAssembly PHP build, take a look at the [`@php-wasm/node` package](https://npmjs.org/@php-wasm/node) which ships the PHP WebAssembly runtime. +- **[WordPress Playground in Node.js](/developers/local-development/php-wasm-node):** For low-level control over the WebAssembly PHP build, explore the [`@php-wasm/node` package](https://npmjs.org/@php-wasm/node), which includes the PHP WebAssembly runtime. From b5636e569bee874e7838844fad31b9380bd2dda7 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:24:33 +0100 Subject: [PATCH 02/26] Adding notice for wp-now deprecation --- .../site/docs/developers/05-local-development/01-wp-now.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/docs/site/docs/developers/05-local-development/01-wp-now.md b/packages/docs/site/docs/developers/05-local-development/01-wp-now.md index 5a63e821ef..7421a0ac31 100644 --- a/packages/docs/site/docs/developers/05-local-development/01-wp-now.md +++ b/packages/docs/site/docs/developers/05-local-development/01-wp-now.md @@ -3,6 +3,10 @@ title: wp-now slug: /developers/local-development/wp-now --- +:::caution Package deprecated +The NPM package wp-now is deprecated, won't receive updates in the future. To use a command-line tool on your developer flow, use the NPM package `@wp-playground/cli`. +::: + # wp-now NPM package [wp-now](https://www.npmjs.com/package/@wp-now/wp-now) is a command-line tool designed to simplify the process of running WordPress locally. It provides a quick and easy way to set up a local WordPress environment with minimal configuration. From 29f171f6d23862733cff7eb5b18acf3ceb2e92c1 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:48:08 +0100 Subject: [PATCH 03/26] Updating readme file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index afc5292fb7..c595682efd 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ These tools include: - [Interactive Code Block for Gutenberg](https://github.com/WordPress/playground-tools/tree/trunk/packages/interactive-code-block/#readme) - [WordPress Playground for Visual Studio Code](https://github.com/WordPress/playground-tools/tree/trunk/packages/vscode-extension/#readme) -- [wp-now](https://github.com/WordPress/playground-tools/tree/trunk/packages/wp-now/#readme) CLI local development environment. +- [@wp-playground/cli](https://github.com/WordPress/wordpress-playground/tree/trunk/packages/playground/cli#readme) CLI local development environment. ## Cloning WordPress Playground repo From db73d5405dacb8d5a912721459309801e90d476b Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:48:25 +0100 Subject: [PATCH 04/26] adding new page playground cli --- .../04-wp-playground-cli.md | 118 ++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md new file mode 100644 index 0000000000..8122656b7f --- /dev/null +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -0,0 +1,118 @@ +--- +title: Playground CLI +slug: /developers/local-development/wp-playground-cli +--- + +# Playground CLI + +[@wp-playground/cli](https://www.npmjs.com/package/@wp-playground/cli) is the new command-line tool designed to simplify the development and testing flow. It runs a WordPress instance locally with Playground, and with the CLI, it is possible to auto-mount an environment with a plugin, theme, or WordPress installation. But if you need flexibility, the CLI supports mounting commands to personalize your local environment. + +## Requirements + +The Playground CLI requires Node.js 20.18 or higher, which is the recommended Long-Term Support (LTS) version. You can download it from the Node.js website. + +**Key features:** + +- **Quick Setup**: Set up a local WordPress environment in seconds. +- **Flexible**: Allows for configuration to adapt to different scenarios +- **Simple Development Environment**: No extra configuration, just a compatible Node installation, and you are ready to use it. + +## Quickstart + +Running the Playground CLI is as simple as go to a command-line terminal and running: + +```bash +npx @wp-playground/cli@latest server +``` + +The previous command, you only get a fresh WordPress, instance to test. Most of the developers want to see their work running, If this is your case, test a plugin or a theme. You can run the CLI on your project folder and run the Playground CLI with the `--auto-mount` flag: + +``bash +cd my-plugin-or-theme-directory +npx @wp-playground/cli@latest server --auto-mount + +```` + +### Choosing a WordPress Version + +By default, the CLI loads the latest stable version of WordPress and PHP 8.0 due to its improved performance. To specify your preferred versions, you can use the flag `--wp=` and `--php=`: + +```bash +npx @wp-playground/cli@latest server --wp=6.8 --php=8.4 +```` + +### Mounting folders manually + +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/ +``` + +### Loading Blueprints + +A way to bring the CLI playground to the next level is to integrate with Blueprints, which allows developers to set up the initial state from their WordPress instance. With the flag `--blueprint` the developer will be capable run a Playground with a custom inital state. + +**(my-blueprint.json)** + +```bash +{ + "landingPage": "/wp-admin/options-general.php?page=akismet-key-config", + "steps": [ + { + "step": "installPlugin", + "pluginData": { + "resource": "wordpress.org/plugins", + "slug": "akismet" + }, + "options": { + "activate": true + } + }, + { + "step": "login", + "username": "admin", + "password": "password" + }, + ] +} +``` + +```bash +npx @wp-playground/cli@latest server --blueprint=my-blueprint.json +``` + +## Command and Arguments + +Playground CLI is simple, configurable, and unopinionated. You can set it up according +to your unique WordPress setup. With the Playground CLI, you can use the following top-level commands: + +- **`server`**: (Default) Starts a local WordPress server. +- **`run-blueprint`**: Executes a Blueprint file without starting a web server. +- **`build-snapshot`**: Builds a ZIP snapshot of a WordPress site based on a Blueprint. + +The `server` command supports the following optional arguments: + +- `--port=`: The port number for the server to listen on. Defaults to 9400. +- `--outfile`: When building, write to this output file. +- `--wp=`: The version of WordPress to use. Defaults to the latest. +- `--auto-mount`: Automatically mount the current directory (plugin, theme, wp-content, etc.). +- `--mount=`: Manually mount a directory (can be used multiple times). Format: /host/path:/vfs/path +- `--mount-before-install`: Mount a directory to the PHP runtime before WordPress installation (can be used multiple times). Format: `"/host/path:/vfs/path"`. +- `--mount-dir`: Mount a directory to the PHP runtime (can be used multiple times). Format: `"/host/path"` `"/vfs/path"`. +- `--mount-dir-before-install`: Mount a directory before WordPress installation (can be used multiple times). Format: `"/host/path"` `"/vfs/path"` +- `--blueprint=`: The path to a JSON Blueprint file to execute. +- `--blueprint-may-read-adjacent-files`: Consent flag: Allow "bundled" resources in a local blueprint to read files in the same directory as the blueprint file. +- `--login`: Automatically log the user in as an administrator. +- `--skip-wordpress-setup`: Do not download or install WordPress. Useful if you are mounting a full WordPress directory. +- `--skip-sqlite-setup`: Do not set up the SQLite database integration. +- `--quiet`: Do not output logs and progress messages. +- `--debug`: Print the PHP error log if an error occurs during boot. + +## Need some help with the CLI? + +With the Playground CLI, you can use the `--help` to get some support about the available commands. + +```bash +npx @wp-playground/cli@latest --help +``` From 6ccad1a10ab80cf277e2ccc45ab0037abb6ae668 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:48:48 +0100 Subject: [PATCH 05/26] Updating resource page --- packages/docs/site/docs/main/resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/main/resources.md b/packages/docs/site/docs/main/resources.md index 19aedcafbd..78dcc36892 100644 --- a/packages/docs/site/docs/main/resources.md +++ b/packages/docs/site/docs/main/resources.md @@ -29,7 +29,7 @@ There's a set of redirections in place to make it easier the access to some of t ## Apps built with WordPress Playground - [Official demo](https://playground.wordpress.net/) and the [showcase](https://developer.wordpress.org/playground) app – install a theme, try out a plugin, create a few pages, export what you've built -- [wp-now](https://www.npmjs.com/package/%40wp-now/wp-now) – a CLI tool for instant WordPress dev envs +- [@wp-playground/cli](https://www.npmjs.com/package/@wp-playground/cli) – a CLI tool for instant WordPress dev envs - [WordPress Playground for VS Code](https://marketplace.visualstudio.com/items?itemName=WordPressPlayground.wordpress-playground) - Live Translations: [App](https://translate.wordpress.org/projects/wp-plugins/friends/dev/pl/default/playground/), [announcement](https://make.wordpress.org/polyglots/2023/04/19/wp-translation-playground/), [more details](https://make.wordpress.org/polyglots/2023/05/08/translate-live-updates-to-the-translation-playground/) - [Interactive code block](https://wordpress.org/plugins/interactive-code-block/) which powers the [HTML Tag Processor tutorial](https://adamadam.blog/2023/02/16/how-to-modify-html-in-a-php-wordpress-plugin-using-the-new-tag-processor-api/) and the [Playground JS API tutorial](https://adamadam.blog/2023/04/12/interactive-intro-to-wordpress-playground-public-api/) From b8bf49372fde990f1ea485a397d6668f02d0d9b7 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:49:01 +0100 Subject: [PATCH 06/26] Updating build page --- packages/docs/site/docs/main/about/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/main/about/build.md b/packages/docs/site/docs/main/about/build.md index 6d9a09ba5a..ffed488c88 100644 --- a/packages/docs/site/docs/main/about/build.md +++ b/packages/docs/site/docs/main/about/build.md @@ -11,7 +11,7 @@ WordPress Playground can help you to create and learn WordPress quickly, even on ## Setting quickly a local WordPress environment -You can seamlessly integrate Playground into your development workflow to launch a local WordPress environment quickly for testing your code. You can do this directly [from the terminal](/developers/local-development/wp-now) or [your preferred IDE.](/developers/local-development/vscode-extension) +You can seamlessly integrate Playground into your development workflow to launch a local WordPress environment quickly for testing your code. You can do this directly [from the terminal](/developers/local-development/wp-playground-cli) or [your preferred IDE.](/developers/local-development/vscode-extension) ## Save changes done on a Block Theme and create Github Pull Requests From 93db410e3cee9c9f57d1371f9b5c0811c0b0ac7b Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:49:15 +0100 Subject: [PATCH 07/26] Updating contributor day page --- .../docs/main/contributing/contributor-day.md | 28 ++++++++----------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/packages/docs/site/docs/main/contributing/contributor-day.md b/packages/docs/site/docs/main/contributing/contributor-day.md index 3b67c3af07..fa53f41f6c 100644 --- a/packages/docs/site/docs/main/contributing/contributor-day.md +++ b/packages/docs/site/docs/main/contributing/contributor-day.md @@ -4,16 +4,12 @@ slug: /contributing/contributor-day # WordCamp Contributor Day -The [WordPress Playground VS Code extension](https://marketplace.visualstudio.com/items?itemName=WordPressPlayground.wordpress-playground) and [wp-now](https://www.npmjs.com/package/@wp-now/wp-now) streamline the process of setting up a local WordPress environment. WordPress Playground powers both—no Docker, MySQL, or Apache required. +The [WordPress Playground VS Code extension](https://marketplace.visualstudio.com/items?itemName=WordPressPlayground.wordpress-playground) and [@wp-playground/cli](https://www.npmjs.com/package/@wp-playground/cli) streamline the process of setting up a local WordPress environment. WordPress Playground powers both—no Docker, MySQL, or Apache required. -Keep reading to learn how to use these tools for [local development](/developers/local-development/wp-now) when contributing to WordPress. Please note that the extension and the NPM package are under development, and not all [Make WordPress teams](https://make.wordpress.org/) are fully supported. +Keep reading to learn how to use these tools for [local development](/developers/local-development/wp-playground-cli) when contributing to WordPress. Please note that the extension and the NPM package are under development, and not all [Make WordPress teams](https://make.wordpress.org/) are fully supported. ## Getting Started -If you’re a visual learner, here’s a step-by-step video tutorial. If you prefer reading at your own pace, skip to the written instructions below. - - - ### VS Code Playground extension The [Visual Studio Code Playground extension](https://marketplace.visualstudio.com/items?itemName=WordPressPlayground.wordpress-playground) is a friendly zero-setup development environment. @@ -23,23 +19,23 @@ The [Visual Studio Code Playground extension](https://marketplace.visualstudio.c 3. To interact with Playground, click the new icon in the **Activity Bar** and hit the **Start WordPress Server** button. 4. A new tab will open in your browser within seconds. -### wp-now NPM package +### @wp-playground/cli NPM package -`@wp-now/wp-now` is a CLI tool that allows you to spin up a WordPress site with a single command. No Docker, MySQL, or Apache are required. +`@wp-playground/cli` is a CLI tool that allows you to spin up a WordPress site with a single command. No Docker, MySQL, or Apache are required. #### Prerequisites -`wp-now` requires Node.js and NPM. If you haven’t yet, [download and install](https://nodejs.org/en/download) both before you begin. +`@wp-playground/cli` requires Node.js 20.18 or superior and NPM. If you haven’t yet, [download and install](https://nodejs.org/en/download) both before you begin. Depending on the Make WordPress team you contribute to, you may need a different Node.js version than the one you have installed. You can use Node Version Manager (NVM) to switch between versions. [Find the installation guide here](https://github.com/nvm-sh/nvm#installing-and-updating). -#### Run wp-now +#### Running `@wp-playground/cli` -You don’t have to install `wp-now` on your device to use it. Navigate to your plugin or theme directory and start `wp-now` with the following commands: +You don’t have to install `@wp-playground/cli` on your device to use it. Navigate to your plugin or theme directory and start `@wp-playground/cli` with the following commands: ```bash cd my-plugin-or-theme-directory -npx @wp-now/wp-now start +npx @wp-playground/cli@latest server --auto-mount ``` ## Ideas for contributors @@ -59,15 +55,15 @@ npm run dev :::info -If you’re unsure about the steps listed above, visit the official [Gutenberg Project Contributor Guide](https://developer.wordpress.org/block-editor/contributors/). Note that in this case, `wp-now` replaces `wp-env`. +If you’re unsure about the steps listed above, visit the official [Gutenberg Project Contributor Guide](https://developer.wordpress.org/block-editor/contributors/). Note that in this case, `@wp-playground/cli` replaces `wp-env`. ::: -Open a new terminal terminal tab, navigate to the Gutenberg directory, and start WordPress using `wp-now`: +Open a new terminal terminal tab, navigate to the Gutenberg directory, and start WordPress using `@wp-playground/cli`: ```bash cd gutenberg -npx @wp-now/wp-now start +npx @wp-playground/cli@latest server --auto-mount ``` When you’re ready, commit and push your changes to your forked repository on GitHub and open a Pull Request on the Gutenberg repository. @@ -87,7 +83,7 @@ npm install npm run dev # In a different terminal inside the Gutenberg directory * -npx @wp-now/wp-now start +npx @wp-playground/cli@latest server --auto-mount ``` #### Test a Gutenberg PR with Playground in the browser From 9c953265e7f740ebb79c2e98fd27078f58542f03 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:49:30 +0100 Subject: [PATCH 08/26] Updating for developers page --- packages/docs/site/docs/main/guides/for-plugin-developers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/docs/site/docs/main/guides/for-plugin-developers.md b/packages/docs/site/docs/main/guides/for-plugin-developers.md index 7d312afff9..4a0041e25a 100644 --- a/packages/docs/site/docs/main/guides/for-plugin-developers.md +++ b/packages/docs/site/docs/main/guides/for-plugin-developers.md @@ -193,7 +193,7 @@ Here’s an example of a **[plugin that generates Custom Post Types](https://raw From a plugins' folder in your local development environment, you can quickly load locally a Playground instance with that plugin loaded and activated. -Use the [`wp-now` command](/developers/local-development/wp-now) from your plugin's root directory using your preferred command line program. +Use the [`@wp-playground/cli` command](/developers/local-development/wp-playground-cli) from your plugin's root directory using your preferred command line program. With [Visual Studio Code](https://code.visualstudio.com/) IDE, you can also use the [Visual Studio Code extension](/developers/local-development/vscode-extension) while working in the root directory of your plugin. @@ -202,7 +202,7 @@ For example: ```bash git clone git@github.com:wptrainingteam/devblog-dataviews-plugin.git cd devblog-dataviews-plugin -npx @wp-now/wp-now start +npx @wp-playground/cli server --auto-mount ``` ### See your local changes in a Playground instance and directly create PRs in a GitHub repo with your changes From 4042682690970d37694a1a5cd7fb480c87552021 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:49:52 +0100 Subject: [PATCH 09/26] Updating the theme developers' page --- packages/docs/site/docs/main/guides/for-theme-developers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/docs/site/docs/main/guides/for-theme-developers.md b/packages/docs/site/docs/main/guides/for-theme-developers.md index 0fec8870a5..e7b9f85d79 100644 --- a/packages/docs/site/docs/main/guides/for-theme-developers.md +++ b/packages/docs/site/docs/main/guides/for-theme-developers.md @@ -214,14 +214,14 @@ The ["Stylish Press"](https://github.com/WordPress/blueprints/tree/trunk/bluepri ### Local theme development and testing with Playground -From the root folder of a block theme's code, you can quickly load locally a Playground instance with that theme loaded and activated. You can do that by launching, in a theme directory, the [`wp-now` command](/developers/local-development/wp-now) from your preferred command line program or the [Visual Code Studio extension](/developers/local-development/vscode-extension) from the [Visual Studio Code](https://code.visualstudio.com/) IDE. +From the root folder of a block theme's code, you can quickly load locally a Playground instance with that theme loaded and activated. You can do that by launching, in a theme directory, the [`@wp-playground/cli` command](/developers/local-development/wp-playground-cli) from your preferred command line program or the [Visual Code Studio extension](/developers/local-development/vscode-extension) from the [Visual Studio Code](https://code.visualstudio.com/) IDE. For example: ``` git clone git@github.com:WordPress/community-themes.git cd community-themes/blue-note -npx @wp-now/wp-now start +npx @wp-playground/cli server --auto-mount ``` ### Design your theme using the WordPress UI and save your changes as Pull Requests From 4af1927e3d43d1fe676afab4ee072b86c7dc3d94 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 7 Jul 2025 17:59:37 +0100 Subject: [PATCH 10/26] Re-ordering text --- .../05-local-development/04-wp-playground-cli.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 8122656b7f..27549ec9bf 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -7,15 +7,15 @@ slug: /developers/local-development/wp-playground-cli [@wp-playground/cli](https://www.npmjs.com/package/@wp-playground/cli) is the new command-line tool designed to simplify the development and testing flow. It runs a WordPress instance locally with Playground, and with the CLI, it is possible to auto-mount an environment with a plugin, theme, or WordPress installation. But if you need flexibility, the CLI supports mounting commands to personalize your local environment. -## Requirements - -The Playground CLI requires Node.js 20.18 or higher, which is the recommended Long-Term Support (LTS) version. You can download it from the Node.js website. - **Key features:** - **Quick Setup**: Set up a local WordPress environment in seconds. -- **Flexible**: Allows for configuration to adapt to different scenarios -- **Simple Development Environment**: No extra configuration, just a compatible Node installation, and you are ready to use it. +- **Flexibility**: Allows for configuration to adapt to different scenarios +- **Simple Environment**: No extra configuration, just a compatible Node installation, and you are ready to use it. + +## Requirements + +The Playground CLI requires Node.js 20.18 or higher, which is the recommended Long-Term Support (LTS) version. You can download it from the Node.js website. ## Quickstart From bc7119e9e0822d8def73719637b1483a78956b6e Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Tue, 8 Jul 2025 12:24:43 +0100 Subject: [PATCH 11/26] adding animated gif for the page and fixing command blocks --- .../_assets/npx-wp-playground-server.gif | Bin 0 -> 24378 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 packages/docs/site/docs/blueprints/_assets/npx-wp-playground-server.gif diff --git a/packages/docs/site/docs/blueprints/_assets/npx-wp-playground-server.gif b/packages/docs/site/docs/blueprints/_assets/npx-wp-playground-server.gif new file mode 100644 index 0000000000000000000000000000000000000000..842cb755d143cbd8b2d8c4a6ba5d14966de6b69c GIT binary patch literal 24378 zcmdqJd0fovAOHRN%s$gL?MaySJs}ifTC}TCX;muGW=SPUn5I2Rn@WXgU$twGDW#2M zi4c-@(V~#8`Ke|8ND~AV`uQck z%wf9I(n3dzvU9zPDiQ|Y7XN{D^EjyD>*WE7FQL$(;9E+}pUwPrA>f~K3Y$KEo|lwX zm66*Zwn|1oaOG-}yx1yf=Fj;*zEI0VNR8I4{`PL;vXfk_tH%}hqS8ZeZ+I)+^E>=1 zpmZi^#tj(~I;$vpp)<#)>(G{~eFc6-8&?zhOZPJg4={=4>zSwyynCea)ofjm zY1#9c&rN6U&3s*^2Gc@9!@?sXqoU8noR7T_7oU)rbTK(4^-@}T#^ozl>6uyCR}gvm z`8h?!CD%%i7gUs0RbQ{EHK{15Yiho6lOfqq*wTKxqqFE%Uf12;dwu775cm5ZKN;|Q z_;m2a%U8C~hu(~gj%^+upL#p}Zq?-bx%m$-W*0tvUTXRH<@=B2?qpcZpqwsq2E(tg z*8nGeD}pH5drYn(tNomloXcQm#eS9G)yq23VoN%bU5RoQMSHs{b9+)$_jhL)R^{DI zSNEM7?5fJYcaCEMt-(eie6=0 zQ}VRR{b7+qPtCRGwcc;KFB{jEzGw{iF!iFRw(QkSDw1QhNnQEtTao;Vj(6%R-gLxC z8ecJ~uN>`3-Qe}|PJPw*J-W`h)w>$1Cm$AA6g%E+xc>G@`Tm|OyBcfWJ+Je9`|@sM z?aV7i2*(=JrnluC9Vj*`nO7>-t|nHWB&dRy*IjM`)OH|N#I3f{zO zew=u7fsBzKiPIJG7>PHKDI7^K*)%zlNYRrYO|rD|7`E5^H$20sMdyHQW7%LpV67+F${3;crFhLI$@|?(wlqs6XirF+Z zksYU}FqxBN^W6fkXJNSR8liFRa|~s;cZFvW6!tO z>c)!RmNtEydRxZ8C{CBR33*LdbjlP@SKit5c6zz0Pfzh(^&=~^0N;d8~Nm#m->@A|c(p;N>^`W_T5x0`L+hQlC=Q>CcO7opkDTn5}1dvfT*UG?#j551b7ra#;xW0e>BbcGKu+&7TDw(!7Y^SgzI6n*8zN0!!y7yE78 zt}Q;^d*a>V6Q>B}j{~kLhd(}b&%gHZ*`eBZAD?@7D1RFCdvf^Gi-7TKpI!!idiUuS z6|3@jC{*~!=hu<4rJsjmHoyP;CQe^vX(Y+|$kJ%4Tj|pBSjLI>OXKtil`j)HDM!9c z7UY+HnJTG$|K)9YhsxLK>L*9OzN;HA{rbM?)BCS84D8x(vu(mhzs+^ZmVKMQvw7y* zhd%wa-xnTPAN{^K;8yni(V=_723~q@&n+;dLlgWLe^VaGwvk_#@EMkN~ zn}q0Gq=88mUrJ}2%$B(*N=%kO{zUo)Zyt^pNUC7f2?&oDpd+4eARq}KtUyhBfI=$a zAOds_$qzB5m93_2?YH(i9*B!i($+Qg4>nayUSPTA)%2kUq0KoS=+6h zfR5e2-&<5vTw7OHTU)!=;eh{%pv#x9{*xG^mz_wll1_hUZW(=M>-%K}-P=IvH_ffq zD>5w`P>S#9XKSuX`n?IY5+n1*SKC#1{?c4*rSWzw;V60wG5{Z8;j``ZUz#g>R$>P_ z+M0_)fRB4!dH@Qci{->&Rb#d!mseCWHPD^QWgwa%W8iHjlc*LZfuA2nQ`YE85+$q#cc#Bq?`ULj1 z77at_h7Cy6?BHlf#>9QoFQL5u5BJq0Bsv7 zdHO+KG>Jeakg2xF8)ExnzqPi~GSopjf`rfTOkx@qZuWA;*KBpkx%0K z-`Z2e2?;*n_D3XU$&bj>jvB z40 z?!&WPcJcCYlBT*Z+@jHf3maflyyWaE`=%eCnKzH%W7$eZHg;YVGY{gCr0Zemuhe|(iuDc1Q&UlhH!eg;SPk!4HZJXyr|qJW7YNX zj!!>Ja}}M;%Zd6s=bj*9L%!(bDfY>pdsM*G+|r`$x^H)@QIf@*zj%*AA7v0{po$L~OM*WO*6I?H>SrMau7@7;`C`pDE= z7a(a&nZq(=?irA|dc@z#9MCwRbZm_Sq6QQVNFI2)zItVT_6|WvtGUdCiA_@*{PWi3yU*z zk3N3+`t9E5s_zJbnETsTYiT%s1rt|FXDcw7tx;^sL?-1ofO7fYP-gQ5Kmk^eNkAF_ z(0`>7Hdz22N2;5iuCb6+Qxq!XPq!V8?R zoCR_U53{0s9h3W8z`funcTf+3JPtBA$m4)Ah-(0v&7BRGo!J3yc7U@}`F|yG@SFba z7iyl;sS)xo(XBDMU*yW~>0DtAIw1Jh37B|Guu%WkrwJLo}Er4}o?^`j7&%<&g{-hk+ykw5)tc46`3@O<~Duiw76EoFbhgAz)B zVT%SO6mEjPIUJmT8b2E|H^8AZ2r$?F5#CJ9ZMWFr4Y&f{A)!$q!U1m(heK`X@~xAu4#gh%IlN!mxy>L6;)u` z{;E{*OD@|x*nyrujyQgXU8x43Nay&@i$KEh!3U$*mFmuOh{Qy{iy17;m#!w1&9dZe&)fGBpClZSkdy&aUpB!uEQrJ51MfjOSKeaYsM1QZ;Jz@qIotHa;=A zjygK^er9%Nx?yhd{{b{O^!(5IAA(UlGTg{G z|4VH7&_S!f7&IMA2+1mBN^^aZGzS`m=Bzr{0OX^i(@_Qm(Ob>CSYC9a3=z$H{MO@_ zK$`QVD@uFghbKY(9|YskxS6@k7wx;j&*vpiFWM)25{ zVNj8EJ@TWHC#e60ZU?Ud<-h#o8-WBl3sg}MKY|5*BNO~I0H6N{cz~SE{y*SZt{+eb z>;ZT{9mF#m{D0B?mmi|KiJkHx%~liF3jd)6v%^`0`_I7UN#*tb71*j5?5;=uRPdW4 z)Wt8Q?Cf~{9y*BKf}x%9jbOK6wnQC_XSHBL61CGpXfIn`0j%E%0;bHm2~|3Sp#G<&l39#SsGe7%Qj?B;^5YU7OL>#+s6$PU? zBoouJz@PhCY1s}AB#h-n@<4^L<9D8Mi_(rvWL>DW)<) zWP_&(HWI#hl(0Ek% zBxH(0x#Trf@+=)xwCi@CZ?tf=YazuGzl;mR6I`T(ZkK>FJ1RX zN*ZMt%o(regH5^USbFdcG#A0(^JrNXvx8{#01vg0si?dKc@p~dUc-yb7GhL9u?VR^ znin&wmSY&~2zjXnT8I`d23RRd;6x#4A>zL@RjDysh>N6AyN%2iV%1NZzJhstXqW)S z{&9T3YO_xbsQa&TWFH^f+JGbrjt?9n^Y~b;2ynOl=S@QOfefpNQ+I3GTKl&d_FM7y z)n>oj^vZrCdAbM;_*KrIvxPg|4WDfFF=iLTmUs@#$+J_SOISK zm0+X%_d9@^SM8Mlms+P-Ak4Y(x8}}pVB)LxUkSC8E?CGgW;S=K1C>$Ow*58ihPtfC z6?Q}28YW=y5I6d$O9;EUBL+h_4h|e=jCm5Pp>CCo;zL1~cjN$JDzA`BM)DycbWkNz znBuBy>Kbk`6RK-o0lt{r#e{e`1&ig$XnVx8DH6#TEJ6g7%p9T=Gz27~% zu=M3CH4M9L;xp3?#-vl3Zm?j4w4Lb&+j!Y-kif)@2biP(8#5a!8#Z9cGB0BwZb7U9 z%m6%aC;%`!RzZ{k!TFz_5H-qlgUzIgYhlZ4Wd3Guq1k(k?(}=Cw!M)bBjY~{Vb!|a|?x-;Nurra|^E&m=$0|M=;1*uwiIFt?z0_9KBCY!T#Tmys+L5C>#^{vgZ73OIteefjD+zzR45 zrXWh$>cCE{03`qlxC7AtQv$#lvV7o(NQRt3$+X??bD-Zue1(aIz4Gt*^jxn%(xUQT z`Sh4`zs>AV6JmYa%-0W80IV|7>1=Q`J8bvCC|(H+j_RAlo&&)IJPPK-aKq=bS?=21 z8JS*M-N59jA&bLEa$LK7lX>?uVLY|~Mj~(Tzw-p#{Q#H)Er)$n|D0Jyn)hM}C?Yi6 zF#*cR1?)zciwDA>fAmwPK-hY}TtnSW0PcGBNy{-VAmZwi&YIC6pN{Om|Lpb!l1|>F z2qg!Ico^cR_=++ES`}d5|2NnHTM)ZIJwVg~{_JQ5*x9E5P&0F9Q8B;{;Dg})pX6EC zLGH|>mnu&F1NKSnOq)M!%;8@C->}~*tmtOfj%Un5u_L}gKRYAa&rlIjZ0y#YNI70~ zOcKk+BmiFnoHZ&vla)K|U_we|N>Mq}`!%V;`6w8ZTiXoOqAN;LW)gGs`Lp!N zU1!*9al(YH)aQRBw<3Njb60KQPXYbRHQqQ7@&)?3h*MZj zO+S4m`vZKuD8RnUFi7tY_IiMnk^x|E{5R~`;tjY0#sD@r0dN!8_`#U~>fjKVLe7$K z5cF)_`CsfMSR;_4p&KfSzsAo0ksH3963Wiyxxd)In@Y=;RU7+DZoV>dCADCY#24(c z^S(E1fIx!A727kO3JwYLN5rx{<3(5ht|;{+BqHkMowctl7|6}wKyDi~B#cib<71z= zZj`{T^ERQa70j{o*#Ot^SqJfONG{c{Q}rtTOv1Nzrf0l!$vJtWfhsHtVF~=I#PSW# zs*f1Ep_|>SfoB}sBJYi$Ghmp9FT=*00U@l*9SdC!v`)8aG}+LYV`pgtqqe10CUvT- z8HT8pVC=k3s4XOP3m7~55Igk+?7`T11IHabwNtBirTO4kw@-l?0X`rC#Q%r@cAX1O z7u-P*2keB-Og=B4fj9sG0pb8e01!VQcpwhg;>Wg8{}ut`U(%j0ted;it(AboB7u>!s z7)vzvMht+SaA6`V@>6BsA5lgux|fcC$bCG;qp?LYQ} z$$a>BUG`E3i!DXNC99gb)WKv+svX&w%UKl!lTbapxQz;g8`|usmQE0h> z=R~83xgC!I+e;TX5;!itV)onXyei)Vw$7nbi@<~GeR}W>+^##X@AWXVN|D@vZsx6s zMQyfCLNm$I09oEY$g*<=J5K<_>|6|@7DO-z=wGqRmN7PN5W4{MzmrAv{o71KE_c7k zZ$n%o{nrk^vPY8Zh5~i;Q#NBm0$p*5cAvF4W7a=S{mB>#a5QBzCWjv0$LhN$#RkT) z4Cuj>Q&+M;<4lWwDG&U$u1N?GaABIIpmCNZfW~7mso`~?SfUAF(J0i->Ne1TxN35N z(Ffw!<3Z210pRmDK6`F91QbkqICEn9-S|`?VBF6xmgJcbeE~$$9}q!Q0*)X&!JTI3 zSP-G$#si=LCHPYS1IlIxf|RKZCxV!u|5xHgy=J=j%i?d98a`S7pW8<-k31iL`=3d8 z{hMP!q`zF}^WyE>qP7cA!eEK!zPY>Ox~xoQ5k#is6=BnUuVS)zb~4Up#WOfSH2Li?ViCg6?C(t`(Uj&W!+K&J`ILi@`v63_7w6 zxcCeh7dAlXV-`ymxA&fW{t7^}J9+ce1ZbV>O^q;H=WFM$FWV^MiU(bb$)x93fsd^|t?rPoV&-fkhhEo&~)L?I=4pM;!~QU0T%#pqlOu0HpV z9NgzRTn9JxDHlJPuCWg?y*a+n@cl}(&fK>f%V+b2Q3f{d0dmrxX`KTTpF1n1v4*xD zCzt5Bkglhbllk%s8b)?TLeHFv8oG-@r}{+|w-!s+>z_+6=9q7I`;|lN{z{X*np+QL zlxW(qFE6V|4+n&}{vgEE!B@|J=fu9hAl5*X0cL;`zy=}_#2V9j6oEk{vrGH$kkIcy zqsr9-p;eTp{kF#KKf7-KF&*yL1Dk(c*%JRo*UAjlQnoBs2abHFJz?*?r2eC_Y z%af-NAuQ8D1wkW0zy_XT%c3F7!NCLLaTkxWWHAFqahik|GxsihfP*9Op^uo>F#8)6 zc^onxpL>&eWs3#2oA45Q%$Pkx2F%X|qXm#pR0cuKmv;x!qrWI&#*=W>L=08b2x!Po-!(T~#p`h_g z^%JYES;^F04c!8PBefd>wYsQzHGv5 zgACaI-v^6&0whzbPUPI*j=_BMPOSPZ@2K2*BlQK`gklDKmnN2#C z;%oM0%tF1Yrc|>TbX$*I;p^bLS=Z7I7B;<3qfv})_d%gvU54%dg(kqMe@YtR~W{(u2XL zn2T7JA+#*jwmFsumBB(7J`MdKnVx}b|5SPL^d@Ldu+IXGC;}B-hd;3%M8@o z+JD0L`}ff=fzkZu5_-zOK%l$xC%|iV5e5nKem}Q|^9~x@Yq5fHHsHOIQSm6Nj9WA5 ze}>h*u$JH;LO9fMj|kTCfeMJqSR?@n2PcE=;T$g*gO|i(uEymuOK2N{GWwc*6|-xk z2;;bI={G>LGd`d5R%s^)M(y(_fP+hy7kYUWMy-K@Tb3`)4DF|z0Xg$qtc4TT0f(6;`ivRWmZUM`C6S| zCz0V3%()yxujIITs{#H{N^rsPleS|I=r+Pl~}!&wWt^qBEWyig8SC?4?TC z-$~tSPw}D(Ta3~^+eW7`?a%RNgq4b0 zjla&@0sGU~!{Pm$Lrh82WXU)vCZoi}t!erj=c--(N)CrlpWmf(`RLe*&!vY2mc{dFo*Rp;Y(PcDTozl;KE738Cw43A_`o_1I4p2{ zKr6sr4LC&hNr7_&2M3N1oF+ImaFpP1fiVNl0o($1PY9Saa0S4D{!`e4W}Ntc@5Hj+ zA^gXifp-WphLrsOG=xA}n-w(T`>X%_YF0gEul8!<{I7QisuG-Fk(3{cmcgPlQCLM( zge4auRUiT4!pm}T$)u(Va)+==RuJrpXe5L}B2l;)2nlP#l?uo!mI$5}1SSD-A?qT{ z0d}8+^2$It1=8AcO>~MYH!law%Nrnr6GrjM^KxT3g!4vwM`f|2;}a)p<+wTL2b+mc zX2RC6pp0Q*C5Uzc11p%h?PJdk+WE4y+hzQO6Vkk zW+;?LY2b7+r*t{1rGcdgDs@s90c-B=lPW5YM`sDGt|2i#i1Z3^!g4lsoaEh*IX_{) zmR4}+ep#Xj$O~qXm{Vhn9_A$tEqmODNw6sghO9*+3{@NZJ~_a8hY)}e zz>-N?D${cZsHow0W5jT|M-h%@j>@+jy=3bmwGkLi@|vJ2!3|Uo+tZ^a%3P%k@-Ebu zWO~5OB=;l)r0PVK$9=2GQRO{Zz=YH&%=3sP9`5Uiy1T2Y9Y6{}Dja<-B| zXNt-X#=L@Oscw*z)Bf{!7Yp62rd~gdx$=Wfq9ZYWqI(PFH9PlSxPHao@v7<-tE-fD z^CIRu1TP(!U>eW~)k9FrvP-L+jTV~Fv@}WJ6H$GQ9~PH(Tz`0z1Xo^h8mYxf;L(Do zbw$zUVos!zURRQgfrdERXD%Ay1!rgT!-Jb9B`V~neM%1X>VbC%yu!0)v~!kksmlAM z$qWRy6lu2#VH`p7k#q>-^l8jGeaFpHp(KNLSHaELmqWNGh9)^Y`3A>>pC?O zI-*dYFCccBcT4gOMX6>YEz&4P`l@prMkY>TP0t*rALkb%DP)MhF9Ny!^NxolW>BT1 zXbktz4k9;Eexb1&BDst5Bp_BHBD;6>cHCNBiU?HF=JCbMUbG`K^iRmIMtNrPpr*4F z8;KB7?~Mx1+9QiqGG0&3zI#6=GGPU>tsGg=g2Z$Z64xL$FelN_-9PL9ln zAt+O7SooHQsrCX~EL=g?%zqkMJF##{>59*}ENX(Qxq%8SMurLM46R-t+TQ*Gn;Vw4 zVqLt!922_RDm8;qN&Abm<*8>!wEH<3PkJhB%yvG0aPfR+ZP$^&4_vdvZo@3~Xs3jt zz+s&OQQYPdoDF1!NpZ|#jMPr;6|EZs8lpFR6TkSb1#>(;UY6jk5uM{rBhL>RLn@J7 zh5~O9qnfrA2#9`JV9L(WD^>Ak*ZtVi<(7cf;d>XxYLhFX7 zufAJkRX@Z~@F-2HG8i{}JK8^d=#ggoYZtRCOTFLjwy8METb>$fD>}oKh|Vp!%294u zTD8TG-e44|Ye8)m9O_m+^PjhH$Nm+x!iYOoLqgVAZ=ShwBB{trq69hv4eBbrhxVC&>>w8r#JVFn~1(t zT1BMOb<4#9IqK@RlAhPxpQr&;BRX#Z{?haEL@bv>@Irt$wv&@?AlVOt=XeNIA7|U@ z-ip|--iEJdk7Jx(RK!IL-a>JTzDfl?mN_SWOq$&GiZ2_+PfgCa&6M|)H9BZAJql=yTT}m zUmg`~rxjYfGHg+)(|o;a}fQS|5)6o41p!jns&^9mR#L0U~pR!R%f#XXeZy7IOyy zbUVNZ1C)=<9R%h8k?C2Os~(`u&KhD(Fn1?G_i~oGdJQ&G!R{pJUNTp&OWg&-omOl_ zfDs1RL1Vt1WG+61wt$&ApJc!>ivD?$&W$gh*O?Y4Y^5wm|Mqq=(TMZn#y{UqPVB%K zB+6{;uJ%yNrCc_;9L-r|USw1C!-eidwZ>xN=1D}l(gg@*&Pk@YD05d!GzB)#9wghs z6oDMUOkoJFM{>uI=%fy)NtU~O;~WFxZI$6fZ4!4P^Hd%@!8o7oq{RgvP+l7>=ISfh zg+K{d1vgZ_5yXf^o@v}HiG=Y@GIHM3V4g}huk<)o`_M_zbflU{A02Yp9Fb|cdfkgs z>%LRjZ~BhVwnn`n^Qo)8cDlRp3Z`|eqmVzxd@%CifY*#NQ25GoSIa3*EeO0&30Vt5 z=eVUhiN275md&TRhSG7-m%JIsbMaJ&CIyXahf3=jtT|3}6@kLfXHpqRsermC2RW#l zo$PFM99lJgFh!Fdr5z`^_vvF_n^Hqr$hAiP zOJTdqv zmRe(fSP(@b!@M!&WEkK1EH@3(B}(i=lP5gSIyZQ>L>zlP3OS0NNmE2i;UL%@e&k7A zuITC)qPkfSR7t@SgK5Q3nRpx-K|e36T~hV9q1E{nhJ#wykkFUyP;WJqTLPQRKD*w# z$4jwvF^`&a!2dkdlJ_E9lzK*1Y?Bw%XKMSnJ<=hl0_VD0^+^4A-pY3o!3a9E0x9Hu z)qPBes%U>BS@p6HYF@?#-)pX^jf4$meJWrn?`g+cBa#+m{;X#_>3x=}Q|XlG2_M@x z;;O+tym8&DQ>mu*$&LQ2t{tszU!gj5zgT=|{{D#23Lj{9#45&s>$%wj__ndV6}SiH zUdlC!y+uA@v&qtHn-8Zf`9GR|u!Z6rokpSN&)+asAc*eJY;C{p5qQ0qC$k$`wkLd+ zAtPg@r>wzWz4K)N#-NXJH!_;HWty6GWPOT-%#aAG6H%@N@sqY`+FmK-8Y`K~+en>( zpqs;vS5-EV;kx`VMh&$0s~7UUXt{{(HMi((9grBK`IAv%xwJiY@bLQMbt#{oIZmCr zeWRsHdc{FRT{a(G&8@yQF3j6_L#%h_`mM-LEHuRN@O*iq%*zVrO<1)R@E&OzPR`52 zo7d*Od&j!>@)!1(1w$fN#zn5YJAla2Am?IqiW0<&phM#4YWU)W<`%mhY!$Umx>`}k z-o+|&kBD9p8cTiGa&#@Xr8TOtHuckSvom5`DyGN8$^!B|DOO~_ch_Kygdmk$Dy}QPWK_jEQ3S;M*@zr62w>27%LFP3l;LY2p zHd~b7rOyZj#}!Ve4HPXP(McJX%i{@QInEbJq;xwEBjKJibz#`lLMUq2+38A-cu7#FM-I zxXs``b4H%2ZI7j?0OguVtj@&+V?Ol{aNh#yvP6`$euJSZ%H z^TIXPUsf6Q9P8P8AiT7y;o82(mNtD&X@$A3$4Y|cxl4P$DEhAwa_6T*H14-g+~>KR z-Nm7epBgTY6Db*{4)lcWi`F7~z1q4LZI5x+G|c3nJ?`04jb^4+Id%zNwRd@NKd0ug zQn!L_k5&KhwX#BIxu8cKIVIsZr{%(9rXENRYP;QLv%-GY zvH)Z-u_Ccb^|{g2}UW$9w7Fq-Uiu6mTe%wSM;@%%lqEJk)V>+$aNBfDXTGu(MOU7J;CZX24q z=Pnx3`zV4D+Yg`wu3ibcA+0ri-r@+)nIX;Laqo_{Ri?|wym(8D^RzEzugA=~nSHYm zZ8)-F)%S;S8dEa-HjLYHdNU_iNo>KCC&F0w3xw*XZK%SyP)Ru#&!@MP`36fvpP?)f zn!csgWZ%$Jt6R#fWhb}cD+FCj<0JT$Gz~bN5K=bBzkW_;L|A=AE3IzP(?7kf14mSg z@UJ;`@Yd+jX#ceqgPUH(X5TQfJ&DqpUJcI}*ySBofcb|WAN1rX+ONN7m*!h1@J9bO zAI%fyj|@hU#hkW#oQgTInBcC!S+WCd^js$L(ruj|iXWxo+DIvz;%x>YlMQ$_8-$o`r_r5X5OS33G4t4U+y&Gj=dKg&JBDTy-0wp* zN2+#jE;vE8ed*@WRR2`%3}h6V>0aIdH8M^ugsi#bZC+|9(Qfy?YP}Dv;vI}2I{F^r z*$^7`G2mn8<@dU!6N{XFCu(MPLhftNl&wQL2cK>pmd_HI^gvw^(%5e8=YJ%cKswpo zSO&$q%?_^ihB6Dw&O=L06ILv~j|t1VBdb*{U+VI@XYS$TYW zSX=0k1EynAhP?gTdVIF%zR~)O7T+-dnW>97h^#EU54{hD^ai%=z`?kzvlq2QaSYSa zmfib0!xgDvdnSb2E1)-X!i5oX1_g+mb#~Pq8?do!xbxXfeyuFQDQTF<7G7x)h-dFZ4=cmC2pxt)O?z_eJPQ=B1u~#X@rqr z9habcDap=RINSn;!u2ta1Gfzw{#+BUOc!4^S)pcHn6y_zphkbsZ8s!B7n+ts&Q+gK zqh7ppU3&M^i$^Z;XXhR6!TBfbhMij0MZ~XM>mC`AdJai}TjNi1Q4@Zb3xqu?mdK zn#h#8mdJ2*zik_!wbsTv4;ou(97?fNe5fVV+IdFJRjuZdP;r;ogxk8RY6^b#z@Ct8 z5y6Kg%GWDxTzk7iY|<+2nMax^KS_ddbp8RvS+#NV$5pa*!i2@0MAwVQZK$`x53Q)) z67yu2_ldMHD{15LILAs+&L_#wm#%(NbzR1hVDVvHhc=;-ogQNz&NmG$tZW?{UK?q- zS!-T*?)F$GoW1q!m}TrqPiH*TTLEqL@sCB&W$bveKT?_y!Un_c1$yZZa%3zEU9$M# z?*~QK?8!{rv=&42D-E-&HGs4mM6i9(8<%tRU>(_poOxBxIb8$kQ2Jif8U!laTF7*} zf?<_}roElC(}P`GqI0(?IGxZ7O%U*FmvH+Sx#3iO>eH?q?YW4J^EwRo}sgBZQh>_&PYI=p*pm2VM z0+;OywKv)8t&uw;j$gGN5xc2vRywS=?CG=GvuY(nhjNn-TE==yAP=caDne>`VO{%@ zE*jc|tt|Gl$qp=BFRAF}dGT^XNju3*+eo(8NXqh}<$SdWhLkf9t$RIF)>T6@GLmHN zbB)7W^2rxjoNDP4f_Sqo6s;{XZ72D@J8Y(V_dS9niX{DHOZ=UNvJc)+{4?)wqUG>b z%del35U0vz>`HNs<($vUxxbbZS61-FYluo#2pJ~{G_DhFtk`j>Lawudl%BY{xJ2B( z(qdhuOnRkkRHef6N}HBSm6cVy;HvfZRXSQ#o6@Vc2Ul%*UZv4ewS8svI=EWfzFJAE zS}(m?G`QO6c{P7awdu<1-0*dC`|E;ut?O3l*MCs2+daR&#JKLbvSxwE+I_(*fzK@Z z_4!1gI)}jY0F>eE0m84j0hl3xN*s(1KpD=Sm9Zyjpcn@=IH<%yJ^uf=690!a>c2k4 z=&wqgJrrlJ^8Ua36eCt84xZ34UxP7+;{V@P;@~wH^A#i5?D(w`XMTzibDgx4xylP3 zL5ne0dBGDT_VnQY51(T6qLVf=)N*3YvP9F#`3dV(o~t*$M}eI-90dw)`6S839Tz#X z`V#_%I916AoJcu?6TwNkwG2VABr^2<#m6^;THLoI%2`K4b7abbdEwC>Uu#A;Wxfpvr~C7*qr- z0FhyoIthkRA|x6D*M`fxh(Uo}2yPTZ9MU4lKMzG15rcy{QQ*^Tcu?iTDDIdzC_*%W zNDq;4*wRj3`;su3sFW%UDN<9=skV$LFYY+6no?!eY$`It zHVcU(4Ka!#F;G4uCkV=AlA83j2>ya%Z-{F|UmJ|WdS*P|Mtz#|7k{<6(qDRiz38uLcts8^*8b5P{);bv}VA8E0RFv#WYKLVX-fq@wQJ;(|I%`0uHn7uql= z6)JznfPOyAv`-4rY(>dN;Ze=Si5QcWpT0m0iegh z2GJjwS+!U3r~nI^eO~k@QeX?$eu-3al^(HK_EMKEfhvetFG5<*B^?gaW<<~HHX(L; z(_}keQAq}f#+`@vp;W~osRB)17&0lNJ;>9wZX(9^h4^o9GF%9gK=~aB9^j{PJx@`p z3obt`Hud_#-hOeOtf45RyVd2U5$X=XuIR>R=0Pz7+RG1jtLix1Hw~@XJnCrpiWYj`C4MAEaArPcT5G3~%;J6OB1c-Q z6@?Hark5H8KKN+JK*UT5%JP)!ZM<~tLfW)ch?w4eK3uie7li^XtPd5jX^)=x<&|?+ zK3Z%l?D61h&N-8#AQ_?6>tSrERjmDN4|Y;%`|drknNDDh;+&-ePbv=*5Gzcc-&@qZSbX2=`v2FKvP&Rxc$H;m^WY#%~ERb;kfl? zmj<%V6_Wpr!f3aey-`S~XI4^6&7gzxm zmWe9NQJmQZnLKJXPi`xy-{GMSCr2|-8G5$`I3eE`3F5xN4Qnw4m+tNwbn@GZmd2}5 zp&U=ai+1i~u(K_KdnjSadq|Tj_riXmwq?t-Isq7M8F*G8@>)X5I?|Gqp@TumaPevb zIfJ8BiBkzjnh%POc?orgTT11}d`@i@t?#UB%Bf22)ASlWTx4P`U5Ot{m6{YcxuN0x z5+$JPV%V}9CeU67snEyxjs|wgANF0dVxW)%vnRbsX>2x7eL~Qw!uo3(+31znLG$$_ zc*ZYNqo1oB=VX?eE+AWR|DCF<4wvQCKv%_8HHX|+^2Flg$R(V86j+md{7EcE{@BEb zl>gSahQKVvH;;8rRys8o3lLNEN=>nIfxVJ~OP$9@-yMCMI53v6fxuZlAHTK%b-uUc zqS&?rI%881f1L%bRj?z{cgxZA?xc?87Owj-JPGN?kp98;Tt~*<8z-prNoV^gKQ-8K z;jw^Je^L9kLuOZwq4;f%@MOrEaTCn!Hs!eC`!wvcH|wO#S3jt99;M{%AM78HI+a&| zQ4+3TbZ=Yfp)LLF4b<|qyXRt3uU)kS$F$enkv)zGE8XD4n}gF&T_28}QdPsH8XkM4 zR;n4&-@d>3G>Q)zjDFY4>41Pw%Z21p_bNLHHZTYWkNOiW5C!`YJ02pu0{o3W6HE#;<+Lpk2@Yx>Ppxi)6a*9= zJcOPKI`ZudIy@F(aquKw-En8N+3BR6=>4)82|MmdZcD-*1I&XwJZXbKdAM@^m+P2TSPg3KXp6E%q zo20H+l+Xx2Yq_@LjkDBe!{x>OJ9&3rgpli2J=t~KB2igBLcNf%W$EylCrMVFl1=`* z+mbHmub?>9A2wbQ;F|CC?YO>kl<)qiF#q}lyQe8`4|RHFd{4M0y4xlfcqgCtKj!Iy zDDd0;%JuMu1+QZsmKA=~%;aQzR7$0l?C#0n{g*E2xL?|~fr6_)QCqu-vfhGUYTtMD z#XSQA+n3JF255Ot&95~UFj zHy5f)F78slXe(i;dTwXJ17wCUW#iQXxz<7hlC(MREHo2hHf+0*^59U1B_g+WYfD(_ zQJFQ>CkcD5ud!Q{vdmRnKD#sS>jnwVd48glne ztroRI@AE`&RY32bLLat4?v%A6)4e?-5guD|%v?Ryh;nUV38qeGEmX6NNc)bDYZzjX zi!R%D`@$;PmQyKE*F1^t62D8GG)`5<7sdf~FEci!BhLFPzK2iD13Kuh4E`brnFD;}Clk+cYgK0km zx-u#aD)YzS7e%E;zA)&@C=?;wFWSsymhyR8p(ya?0{Uk4&Axm7uK;ofjrai$!!`1n zUTdW^bS18u>aVhMc=FLXP9r-NFsVc3udl*W_(Py`gD-pKH2u1+adm!Z_{}DM_D{|SXF{2jM@MR(jXtXKQAHzZ)b0;I)_`7WkCfd8FOV8 zltoJPY636;_){q5>LmYtRyu2@EEppxfkrX%Q7iW&A6aX!Af~C{BLEH{k{F{m4v;}3 z)n`$gv-+5}zY0~PIb|6mY`e7+evN3jy4F7C!it9nq*#?0G_x4l%+3FCq2PJ0BCkf*rR6mmO;>VibxpGmZhHwaVi?%A=|QnIMQ_pg@~% z4{U>cq?-S>hq)qHtPNy^(rIo5<%fTom@~9DFm%F7NxgCyC_w}p$ITQ;JH5%5Y}R|0x=W;S547wX3-vnKLtc@q#`N! z)4P+qBaCV(gKUYPf++yUA-IQ`RwPgP^G+)bE;VwBFx^R@GAqa>DfTu2MHe;clUeF$ zDP=9xAnc2xC0bYV01wbJt#See5Ze8>KLP03ivzMT2HIrPDrE|SHJ3w?Q>=1SbcN+o zD>B;aqAsYz+pSV_#Dk!SgC$glC85n%-nXx9sM`BO0726#!IB^hFs4{SHZ^Um%?vBE z{oG@G+f>LUQ1}4Kblq;4+_qDItNqsS9q zTHh!EC6>L}cUsE;E)>vx;0nIr3@#d=_$duO7!Q7l5gr&5K7tia7Z;x4fU)5m?iU{Z z;d~L|BCZ!CUgCIh;wWwxD!$?xKH)B&7cCy+aWUgG{uVZV<86`SI=&V>-s5TU<3N5E zLO$eWQRGIR|{^oEV=W;&hbYACne&=|e=X$>9eBS4N{^x)m=z>1zgkI=|e&~pv z=!(ARjNa&u{^*b%>5@L_lwRqUe(9K=>6*UjoZji4{^_6|>Y_gCq+aT#e(L|Ip6aT; z>a5=CuKwz<9_z9`>$G0$wtnllp6j~4>%89UzW(dL9_+$C?8IK|#(wO`p6trL?9ATm z&i?Gs9_`XT?bKfF)_(2Sp6%Mc?cCn&-u~_29`52k?&MzX=6>$zp6=?t?(E*~?*8uZ z9`Eu#@AO{p_I~g9p6~j;@BH5H{{HU(AMgS{@C0A*27mAfpYRI5@C@JZ4*&2FAMp}D z@f2V27Ju;=pYa;M@f_dr9{=$mAMzqU@+4pKCV%oMpYkfd@+{x-F8}f{AM-Ll^E6-c zHh=RtpYuAu^E}`4KL7JTAM`>$^h96uMt}53pY%$<^i1FMPXF{!ANBK6KlM~!^;UoN zSfBM;zx7<-^TYhkRSPyKlzkj`IdkAn4kHYzxkZs z`JVszpdb38Kl-F!`lf&SsGs_(zxu4-`mX=_upj%fKl`*_`?i1kxS#vFzx%x3`@aAC zz#sg=Km5dB{KkL$$e;Ymzx>SK{LcUU&>#KMKmF8S{nmf|*q{B{zx~|b{oeom;2-|t fKmO!j{^o!F=%4=Tzy9ps{_g+&@E`w<5CQ-@OYAp| literal 0 HcmV?d00001 From d646818d7ef2f04ae8fcd4871faa754e0b09d46f Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Tue, 8 Jul 2025 12:25:00 +0100 Subject: [PATCH 12/26] fixing command blocks --- .../05-local-development/04-wp-playground-cli.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 27549ec9bf..b3f95f8c08 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -15,7 +15,7 @@ slug: /developers/local-development/wp-playground-cli ## Requirements -The Playground CLI requires Node.js 20.18 or higher, which is the recommended Long-Term Support (LTS) version. You can download it from the Node.js website. +The Playground CLI requires Node.js 20.18 or higher, which is the recommended Long-Term Support (LTS) version. You can download it from the [Node.js website](https://nodejs.org/en/download). ## Quickstart @@ -25,13 +25,15 @@ Running the Playground CLI is as simple as go to a command-line terminal and run npx @wp-playground/cli@latest server ``` +![Playground CLI in Action](./_assets/npx-wp-playground-server.gif) + The previous command, you only get a fresh WordPress, instance to test. Most of the developers want to see their work running, If this is your case, test a plugin or a theme. You can run the CLI on your project folder and run the Playground CLI with the `--auto-mount` flag: -``bash +```bash cd my-plugin-or-theme-directory npx @wp-playground/cli@latest server --auto-mount -```` +``` ### Choosing a WordPress Version @@ -39,7 +41,7 @@ By default, the CLI loads the latest stable version of WordPress and PHP 8.0 due ```bash npx @wp-playground/cli@latest server --wp=6.8 --php=8.4 -```` +``` ### Mounting folders manually From 426c768ce7aa5ac5e30046b128ae2e633a9906a9 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Wed, 9 Jul 2025 16:10:37 +0100 Subject: [PATCH 13/26] re-ordering content, fixing typos and add manual mounting scenarios. --- .../04-wp-playground-cli.md | 39 +++++++++++++------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index b3f95f8c08..d9003ed045 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -32,10 +32,9 @@ The previous command, you only get a fresh WordPress, instance to test. Most of ```bash cd my-plugin-or-theme-directory npx @wp-playground/cli@latest server --auto-mount - ``` -### Choosing a WordPress Version +### Choosing a WordPress and PHP Version By default, the CLI loads the latest stable version of WordPress and PHP 8.0 due to its improved performance. To specify your preferred versions, you can use the flag `--wp=` and `--php=`: @@ -43,17 +42,11 @@ By default, the CLI loads the latest stable version of WordPress and PHP 8.0 due npx @wp-playground/cli@latest server --wp=6.8 --php=8.4 ``` -### Mounting folders manually - -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/ -``` - ### Loading Blueprints -A way to bring the CLI playground to the next level is to integrate with Blueprints, which allows developers to set up the initial state from their WordPress instance. With the flag `--blueprint` the developer will be capable run a Playground with a custom inital state. +One way to take your Playground CLI development experience to the next level is to integrate with [Blueprints](/blueprints/getting-started/). For those unfamiliar with this technology, it allows developers to configure the initial state for their WordPress Playground instances. + +Using the `--blueprint=` flag, developers can run a Playground with a custom initial state. We’ll use the example below to do this. **(my-blueprint.json)** @@ -80,10 +73,32 @@ A way to bring the CLI playground to the next level is to integrate with Bluepri } ``` +CLI command loading a blueprint: + ```bash npx @wp-playground/cli@latest server --blueprint=my-blueprint.json ``` +### Mounting folders manually + +Some projects have a specific structure that requires a custom configuration; for example, your repository contains all the files in the `/wp-content/` folder. So in this scenario, you can specify to the Playground CLI that it will mount your project from that folder using the `--mount` flag. + +```bash +npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/ +``` + +### Mounting before WordPress installation + +Consider mounting your WordPress project files before the WordPress installation begins. This approach is beneficial if you have local files with custom functionalities, like a `SQLite` database, or if you're connecting Playground with `WP-CLI`. The `--mount-before-install` flag supports this process. + +```bash +npx @wp-playground/cli@latest server --mount-before-install=.:/wordpress/ +``` + +:::info +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 Playground CLI is simple, configurable, and unopinionated. You can set it up according @@ -99,7 +114,7 @@ The `server` command supports the following optional arguments: - `--outfile`: When building, write to this output file. - `--wp=`: The version of WordPress to use. Defaults to the latest. - `--auto-mount`: Automatically mount the current directory (plugin, theme, wp-content, etc.). -- `--mount=`: Manually mount a directory (can be used multiple times). Format: /host/path:/vfs/path +- `--mount=`: Manually mount a directory (can be used multiple times). Format: `"/host/path:/vfs/path"`. - `--mount-before-install`: Mount a directory to the PHP runtime before WordPress installation (can be used multiple times). Format: `"/host/path:/vfs/path"`. - `--mount-dir`: Mount a directory to the PHP runtime (can be used multiple times). Format: `"/host/path"` `"/vfs/path"`. - `--mount-dir-before-install`: Mount a directory before WordPress installation (can be used multiple times). Format: `"/host/path"` `"/vfs/path"` From 790a95087d7e0cd1964f0506682ad23e0463bd89 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:29:42 +0100 Subject: [PATCH 14/26] Update packages/docs/site/docs/developers/05-local-development/01-wp-now.md Co-authored-by: Bero --- .../docs/site/docs/developers/05-local-development/01-wp-now.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/01-wp-now.md b/packages/docs/site/docs/developers/05-local-development/01-wp-now.md index 7421a0ac31..9a8579cddf 100644 --- a/packages/docs/site/docs/developers/05-local-development/01-wp-now.md +++ b/packages/docs/site/docs/developers/05-local-development/01-wp-now.md @@ -4,7 +4,7 @@ slug: /developers/local-development/wp-now --- :::caution Package deprecated -The NPM package wp-now is deprecated, won't receive updates in the future. To use a command-line tool on your developer flow, use the NPM package `@wp-playground/cli`. +The NPM package @wp-now/wp-now is deprecated, won't receive updates in the future. To use a command-line tool on your developer flow, use the NPM package `@wp-playground/cli`. ::: # wp-now NPM package From 31137749f695e7fc592170df90d33fb7ded370ca Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:31:12 +0100 Subject: [PATCH 15/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../developers/05-local-development/04-wp-playground-cli.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index d9003ed045..41242e4c72 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -5,7 +5,8 @@ slug: /developers/local-development/wp-playground-cli # Playground CLI -[@wp-playground/cli](https://www.npmjs.com/package/@wp-playground/cli) is the new command-line tool designed to simplify the development and testing flow. It runs a WordPress instance locally with Playground, and with the CLI, it is possible to auto-mount an environment with a plugin, theme, or WordPress installation. But if you need flexibility, the CLI supports mounting commands to personalize your local environment. +[@wp-playground/cli](https://www.npmjs.com/package/@wp-playground/cli) is a command-line tool that simplifies the WordPress development and testing flow. +Playground CLI supports auto-mounting a directory with a plugin, theme, or WordPress installation. But if you need flexibility, the CLI supports mounting commands to personalize your local environment. **Key features:** From 4bc48f24b33655a2e30df499ff4f0f997b5fb19d Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:31:23 +0100 Subject: [PATCH 16/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../developers/05-local-development/04-wp-playground-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 41242e4c72..e014c70bad 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -11,7 +11,7 @@ Playground CLI supports auto-mounting a directory with a plugin, theme, or WordP **Key features:** - **Quick Setup**: Set up a local WordPress environment in seconds. -- **Flexibility**: Allows for configuration to adapt to different scenarios +- **Flexibility**: Allows for configuration to adapt to different scenarios. - **Simple Environment**: No extra configuration, just a compatible Node installation, and you are ready to use it. ## Requirements From e6ff7e6c052685744cf879b4c6bb17e9c2e71e6d Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:31:41 +0100 Subject: [PATCH 17/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../developers/05-local-development/04-wp-playground-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index e014c70bad..37e24fd637 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -12,7 +12,7 @@ Playground CLI supports auto-mounting a directory with a plugin, theme, or WordP - **Quick Setup**: Set up a local WordPress environment in seconds. - **Flexibility**: Allows for configuration to adapt to different scenarios. -- **Simple Environment**: No extra configuration, just a compatible Node installation, and you are ready to use it. +- **Simple Environment**: No extra configuration, just a compatible Node version, and you are ready to use it. ## Requirements From 7f660a02a7b50096095404bb87ff99cd83917068 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:32:21 +0100 Subject: [PATCH 18/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../04-wp-playground-cli.md | 20 ++++--------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 37e24fd637..49871fbfa2 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -54,22 +54,10 @@ Using the `--blueprint=` flag, developers can run a Playgroun ```bash { "landingPage": "/wp-admin/options-general.php?page=akismet-key-config", - "steps": [ - { - "step": "installPlugin", - "pluginData": { - "resource": "wordpress.org/plugins", - "slug": "akismet" - }, - "options": { - "activate": true - } - }, - { - "step": "login", - "username": "admin", - "password": "password" - }, + "login": true, + "plugins": [ + "hello-dolly", + "https://raw.githubusercontent.com/adamziel/blueprints/trunk/docs/assets/hello-from-the-dashboard.zip" ] } ``` From e991da6442030a8b1c614122c5b22849d7b65c0a Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:33:17 +0100 Subject: [PATCH 19/26] Update packages/docs/site/docs/main/contributing/contributor-day.md Co-authored-by: Bero --- packages/docs/site/docs/main/contributing/contributor-day.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/main/contributing/contributor-day.md b/packages/docs/site/docs/main/contributing/contributor-day.md index a34f95e497..5d0fd0f8cc 100644 --- a/packages/docs/site/docs/main/contributing/contributor-day.md +++ b/packages/docs/site/docs/main/contributing/contributor-day.md @@ -25,7 +25,7 @@ The [Visual Studio Code Playground extension](https://marketplace.visualstudio.c #### Prerequisites -`@wp-playground/cli` requires Node.js 20.18 or superior and NPM. If you haven’t yet, [download and install](https://nodejs.org/en/download) both before you begin. +`@wp-playground/cli` requires Node.js 20.18 or newer and NPM. If you haven’t yet, [download and install](https://nodejs.org/en/download) both before you begin. Depending on the Make WordPress team you contribute to, you may need a different Node.js version than the one you have installed. You can use Node Version Manager (NVM) to switch between versions. [Find the installation guide here](https://github.com/nvm-sh/nvm#installing-and-updating). From edc73be70455b5de3c7296dfbf14a5a9cdb6a266 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Fri, 11 Jul 2025 10:33:41 +0100 Subject: [PATCH 20/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../developers/05-local-development/04-wp-playground-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 49871fbfa2..855e8268fa 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -73,7 +73,7 @@ npx @wp-playground/cli@latest server --blueprint=my-blueprint.json Some projects have a specific structure that requires a custom configuration; for example, your repository contains all the files in the `/wp-content/` folder. So in this scenario, you can specify to the Playground CLI that it will mount your project from that folder using the `--mount` flag. ```bash -npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/ +npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/MY-PLUGIN-DIRECTORY ``` ### Mounting before WordPress installation From ef6ac7854c3e99d1fef18a79b3fa5c30a3d56e45 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 14 Jul 2025 17:18:40 +0100 Subject: [PATCH 21/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../developers/05-local-development/04-wp-playground-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 855e8268fa..87797200fe 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -20,7 +20,7 @@ The Playground CLI requires Node.js 20.18 or higher, which is the recommended Lo ## Quickstart -Running the Playground CLI is as simple as go to a command-line terminal and running: +Running the Playground CLI is as simple as go to a command-line and run: ```bash npx @wp-playground/cli@latest server From d5f9a3f969b37ec3019e44e3b8760357498ab245 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 14 Jul 2025 17:18:48 +0100 Subject: [PATCH 22/26] Update packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Co-authored-by: Bero --- .../developers/05-local-development/04-wp-playground-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 87797200fe..d466348009 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -28,7 +28,7 @@ npx @wp-playground/cli@latest server ![Playground CLI in Action](./_assets/npx-wp-playground-server.gif) -The previous command, you only get a fresh WordPress, instance to test. Most of the developers want to see their work running, If this is your case, test a plugin or a theme. You can run the CLI on your project folder and run the Playground CLI with the `--auto-mount` flag: +With the previous command, you only get a fresh WordPress instance to test. Most of the developers want to see their work running. If this is your case, test a plugin or a theme. You can run the CLI on your project folder and run the Playground CLI with the `--auto-mount` flag: ```bash cd my-plugin-or-theme-directory From 9ba0af7520539c3dc0edee8065359940da155d77 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Mon, 14 Jul 2025 17:23:55 +0100 Subject: [PATCH 23/26] applying suggestion for clarity on this paragraph --- .../developers/05-local-development/04-wp-playground-cli.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index d466348009..1f25255dd4 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -54,7 +54,7 @@ Using the `--blueprint=` flag, developers can run a Playgroun ```bash { "landingPage": "/wp-admin/options-general.php?page=akismet-key-config", - "login": true, + "login": true, "plugins": [ "hello-dolly", "https://raw.githubusercontent.com/adamziel/blueprints/trunk/docs/assets/hello-from-the-dashboard.zip" @@ -78,7 +78,7 @@ npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/MY- ### Mounting before WordPress installation -Consider mounting your WordPress project files before the WordPress installation begins. This approach is beneficial if you have local files with custom functionalities, like a `SQLite` database, or if you're connecting Playground with `WP-CLI`. The `--mount-before-install` flag supports this process. +Consider mounting your WordPress project files before the WordPress installation begins. This approach is beneficial if you want to override the Playground boot process, as it can help connect Playground with `WP-CLI`. The `--mount-before-install` flag supports this process. ```bash npx @wp-playground/cli@latest server --mount-before-install=.:/wordpress/ From 40e69188b7e304d62a076768fbf4642fd9b0056a Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Tue, 15 Jul 2025 10:40:10 +0100 Subject: [PATCH 24/26] Moving npx-wp-playground-server to the static image folder --- .../05-local-development/04-wp-playground-cli.md | 2 +- .../img}/npx-wp-playground-server.gif | Bin 2 files changed, 1 insertion(+), 1 deletion(-) rename packages/docs/site/{docs/blueprints/_assets => static/img}/npx-wp-playground-server.gif (100%) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index 1f25255dd4..e4221598ad 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -26,7 +26,7 @@ Running the Playground CLI is as simple as go to a command-line and run: npx @wp-playground/cli@latest server ``` -![Playground CLI in Action](./_assets/npx-wp-playground-server.gif) +![Playground CLI in Action](@site/static/img/npx-wp-playground-server.gif) With the previous command, you only get a fresh WordPress instance to test. Most of the developers want to see their work running. If this is your case, test a plugin or a theme. You can run the CLI on your project folder and run the Playground CLI with the `--auto-mount` flag: diff --git a/packages/docs/site/docs/blueprints/_assets/npx-wp-playground-server.gif b/packages/docs/site/static/img/npx-wp-playground-server.gif similarity index 100% rename from packages/docs/site/docs/blueprints/_assets/npx-wp-playground-server.gif rename to packages/docs/site/static/img/npx-wp-playground-server.gif From 83429af1132884d6edffe527ad200365a29beb4a Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Tue, 15 Jul 2025 10:43:14 +0100 Subject: [PATCH 25/26] moving gif to the developers folder --- .../05-local-development/04-wp-playground-cli.md | 2 +- .../{ => developers}/npx-wp-playground-server.gif | Bin 2 files changed, 1 insertion(+), 1 deletion(-) rename packages/docs/site/static/img/{ => developers}/npx-wp-playground-server.gif (100%) diff --git a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md index e4221598ad..d2cd079f3d 100644 --- a/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md +++ b/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md @@ -26,7 +26,7 @@ Running the Playground CLI is as simple as go to a command-line and run: npx @wp-playground/cli@latest server ``` -![Playground CLI in Action](@site/static/img/npx-wp-playground-server.gif) +![Playground CLI in Action](@site/static/img/developers/npx-wp-playground-server.gif) With the previous command, you only get a fresh WordPress instance to test. Most of the developers want to see their work running. If this is your case, test a plugin or a theme. You can run the CLI on your project folder and run the Playground CLI with the `--auto-mount` flag: diff --git a/packages/docs/site/static/img/npx-wp-playground-server.gif b/packages/docs/site/static/img/developers/npx-wp-playground-server.gif similarity index 100% rename from packages/docs/site/static/img/npx-wp-playground-server.gif rename to packages/docs/site/static/img/developers/npx-wp-playground-server.gif From 9a51c6b6612a676a91b608b0351eea59ff22fe68 Mon Sep 17 00:00:00 2001 From: Fellyph Cintra Date: Tue, 15 Jul 2025 10:57:33 +0100 Subject: [PATCH 26/26] Removing wp-now from the documentation sidebar --- packages/docs/site/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/site/sidebars.js b/packages/docs/site/sidebars.js index bbd6943856..6199bd27c1 100644 --- a/packages/docs/site/sidebars.js +++ b/packages/docs/site/sidebars.js @@ -134,7 +134,7 @@ const sidebars = { id: 'developers/local-development/intro', }, items: [ - 'developers/local-development/wp-now', + 'developers/local-development/wp-playground-cli', 'developers/local-development/vscode-extension', 'developers/local-development/php-wasm-node', ],