Minuscule CLI README tweak - #2917
Merged
Merged
Conversation
Collaborator
📊 Performance Test ResultsComparing 3c877c9 vs trunk app-size
site-editor
site-startup
Results are median values from multiple test runs. Legend: 🟢 Improvement (faster) | 🔴 Regression (slower) | ⚪ No change (<50ms diff) |
wojtekn
approved these changes
Mar 26, 2026
| promises: { | ||
| readFile: readFileMock, | ||
| readdir: readdirMock, | ||
| rename: vi.fn().mockResolvedValue( undefined ), |
Contributor
There was a problem hiding this comment.
Is it a desired change in this PR?
Contributor
Author
There was a problem hiding this comment.
No, it's not. I pushed this to the wrong branch. I'll undo it
sejas
approved these changes
Mar 26, 2026
sejas
left a comment
sejas
left a comment
Member
There was a problem hiding this comment.
Looks great! I left a suggestion, but it's a small thing about wording, and not a strong opinion.
We could consider adding a Gif that shows how to use the CLI. See wp-now Readme as an example:
| - Create, run, and manage local WordPress sites from the terminal. | ||
| - Run WP-CLI commands. | ||
| - Publish ephemeral preview sites to share (requires WordPress.com login). | ||
| - Integrate with AI coding agents. Every site comes with `AGENTS.md` file. |
Member
There was a problem hiding this comment.
Thanks for adding it! ❤️
Alternatively, we could consider using the word “tools,” but I’m no longer sure what the best word is.
I think we need a preposition before AGENTS.md:
- Integrate with AI coding tools. Every site comes with an AGENTS.md file.
Contributor
Author
There was a problem hiding this comment.
we need a preposition
Yikes. Thanks for catching that
Contributor
Author
I think that's a great idea 👍 I'd file it under "future improvements", though |
fredrikekelund
added a commit
that referenced
this pull request
Mar 26, 2026
* Minuscule CLI README tweak * Fix tests * Address review comments
fredrikekelund
added a commit
that referenced
this pull request
Mar 26, 2026
* [skip ci] Code freeze: Update translatable strings for 1.7.7 * [skip ci] Code freeze: Add draft release notes for 1.7.7 * Fix Prettier lint error in ipc-handlers import statement (#2893) * Update Studio CLI settings toggle copy and layout (#2855) * Update Studio CLI toggle copy and layout Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix unit tests to follow UI change --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Wojtek Naruniec <wojtek@naruniec.me> * Studio: Borders don't have correct colors in dark mode (#2885) * Add rule for buttons borders * Improve comment --------- Co-authored-by: Kateryna Kodonenko <kateryna@automattic.com> * [skip ci] Update translations * [skip ci] Bump version to 1.7.7-beta1 * Update CLI version * Preliminary release notes cleanup * Fix: CLI doesn't generate site thumbnails (#2850) * Consolidate thumbnail capture to shared CLI path Create a single thumbnail capture path through captureSiteThumbnail() that is used by both the desktop UI (loadThemeDetails) and CLI events subscriber. This eliminates duplication and uses pendingCaptures deduplication to prevent concurrent BrowserWindow creation when the same site is captured by multiple paths simultaneously. * remove comments * Use sequential util with deduplicateKey for thumbnail capture * Fix E2E copy-site test targeting wrong BrowserWindow The thumbnail capture feature creates hidden BrowserWindows for screenshots. The copy-site test used getAllWindows()[0] to send the IPC event, which could target the screenshot window instead of the main app window, causing the copy action to silently fail. Use getFocusedWindow() with a visible-window fallback instead. --------- Co-authored-by: katinthehatsite <katerynakodonenko@gmail.com> * Disable Redis/memcached when JSPI is unavailable (#2900) * Disable Redis and memcached PHP extensions when JSPI is unavailable These extensions require JSPI (JavaScript Promise Integration), which is only available in Node.js 24+. On Node <24, enabling them crashes the WordPress server at startup. This conditionally disables them when JSPI isn't available, matching the pattern in process-manager-daemon.ts. Also bumps the minimum engine version to >=24.0.0 since the production build strips asyncify binaries, making Node 24+ a de facto requirement. * Revert engine version bump to >=22.0.0 * Sort sites by sortOrder when loading from IPC (#2902) * Fix regressions around deleting preview sites (#2903) * Support deleting all preview sites from CLI and app * Update tests * Fix * Improve schemas and types * Tweak * Fix JSPI detection using runtime feature check (#2906) * Fix JSPI detection using runtime feature check instead of Node version Replace semver.gte(process.version, '24.0.0') with a runtime check for WebAssembly.promising to detect JSPI availability. The version check assumed Node 24+ has JSPI enabled by default, but it requires the --experimental-wasm-jspi flag. This caused "Redis extension requires JSPI" errors when running CLI commands directly without the flag. Extract the check into a shared isJspiAvailable helper in tools/common/lib/jspi.ts so there is a single source of truth. * Remove unverified claim about JSPI proposal stage from comment * Fix linting * Address review suggestions * Pass `--experimental-wasm-jspi` to node in bin script --------- Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com> * [skip ci] Update translations * [skip ci] Bump version to 1.7.7-beta2 * Minuscule CLI README tweak (#2917) * Minuscule CLI README tweak * Fix tests * Address review comments * Rename `appdata-v1.json` to `appdata-v1.deprecated.json` (#2916) * Rename `appdata-v1.json` to `appdata-v1.deprecated.json` * Fix tests * Fix tests * Fix tests * Fix What's New current step icon color in dark mode (#2921) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update release notes for 1.7.7 (#2905) * Update release notes for 1.7.7 * Address review suggestions * Ensure that language packs are bundled in `wp-files` (#2922) * Add phpMyAdmin to What's New dialog (#2920) * Add phpMyAdmin to What's New dialog Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Improve wording * Force What's New for next version * Update phpMyAdmin illustration with dot grid background Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Shaun Andrews <shaun@automattic.com> * Refactor and clean up site deletion logic in app (#2915) * Refactor site deletion in app * Nit fix * [skip ci] Bump version to 1.7.7-beta3 --------- Co-authored-by: Roberto Aranda <roberto.aranda@automattic.com> Co-authored-by: Shaun Andrews <shaun@automattic.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Wojtek Naruniec <wojtek@naruniec.me> Co-authored-by: katinthehatsite <katerynakodonenko@gmail.com> Co-authored-by: Kateryna Kodonenko <kateryna@automattic.com> Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com> Co-authored-by: Gergely Csécsey <gergely.csecsey@automattic.com> Co-authored-by: Ivan Ottinger <ivan.ottinger@automattic.com> Co-authored-by: Bernardo Cotrim <bmmcotrim@gmail.com> Co-authored-by: Fredrik Rombach Ekelund <fredrik@f26d.dev> Co-authored-by: Antonio Sejas <antonio.sejas@automattic.com> Co-authored-by: Wojtek Naruniec <wojtek.naruniec@automattic.com>
fredrikekelund
added a commit
that referenced
this pull request
Mar 27, 2026
* [skip ci] Code freeze: Update translatable strings for 1.7.7 * [skip ci] Code freeze: Add draft release notes for 1.7.7 * Fix Prettier lint error in ipc-handlers import statement (#2893) * Update Studio CLI settings toggle copy and layout (#2855) * Update Studio CLI toggle copy and layout Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix unit tests to follow UI change --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Wojtek Naruniec <wojtek@naruniec.me> * Studio: Borders don't have correct colors in dark mode (#2885) * Add rule for buttons borders * Improve comment --------- Co-authored-by: Kateryna Kodonenko <kateryna@automattic.com> * [skip ci] Update translations * [skip ci] Bump version to 1.7.7-beta1 * Update CLI version * Preliminary release notes cleanup * Fix: CLI doesn't generate site thumbnails (#2850) * Consolidate thumbnail capture to shared CLI path Create a single thumbnail capture path through captureSiteThumbnail() that is used by both the desktop UI (loadThemeDetails) and CLI events subscriber. This eliminates duplication and uses pendingCaptures deduplication to prevent concurrent BrowserWindow creation when the same site is captured by multiple paths simultaneously. * remove comments * Use sequential util with deduplicateKey for thumbnail capture * Fix E2E copy-site test targeting wrong BrowserWindow The thumbnail capture feature creates hidden BrowserWindows for screenshots. The copy-site test used getAllWindows()[0] to send the IPC event, which could target the screenshot window instead of the main app window, causing the copy action to silently fail. Use getFocusedWindow() with a visible-window fallback instead. --------- Co-authored-by: katinthehatsite <katerynakodonenko@gmail.com> * Disable Redis/memcached when JSPI is unavailable (#2900) * Disable Redis and memcached PHP extensions when JSPI is unavailable These extensions require JSPI (JavaScript Promise Integration), which is only available in Node.js 24+. On Node <24, enabling them crashes the WordPress server at startup. This conditionally disables them when JSPI isn't available, matching the pattern in process-manager-daemon.ts. Also bumps the minimum engine version to >=24.0.0 since the production build strips asyncify binaries, making Node 24+ a de facto requirement. * Revert engine version bump to >=22.0.0 * Sort sites by sortOrder when loading from IPC (#2902) * Fix regressions around deleting preview sites (#2903) * Support deleting all preview sites from CLI and app * Update tests * Fix * Improve schemas and types * Tweak * Fix JSPI detection using runtime feature check (#2906) * Fix JSPI detection using runtime feature check instead of Node version Replace semver.gte(process.version, '24.0.0') with a runtime check for WebAssembly.promising to detect JSPI availability. The version check assumed Node 24+ has JSPI enabled by default, but it requires the --experimental-wasm-jspi flag. This caused "Redis extension requires JSPI" errors when running CLI commands directly without the flag. Extract the check into a shared isJspiAvailable helper in tools/common/lib/jspi.ts so there is a single source of truth. * Remove unverified claim about JSPI proposal stage from comment * Fix linting * Address review suggestions * Pass `--experimental-wasm-jspi` to node in bin script --------- Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com> * [skip ci] Update translations * [skip ci] Bump version to 1.7.7-beta2 * Minuscule CLI README tweak (#2917) * Minuscule CLI README tweak * Fix tests * Address review comments * Rename `appdata-v1.json` to `appdata-v1.deprecated.json` (#2916) * Rename `appdata-v1.json` to `appdata-v1.deprecated.json` * Fix tests * Fix tests * Fix tests * Fix What's New current step icon color in dark mode (#2921) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update release notes for 1.7.7 (#2905) * Update release notes for 1.7.7 * Address review suggestions * Ensure that language packs are bundled in `wp-files` (#2922) * Add phpMyAdmin to What's New dialog (#2920) * Add phpMyAdmin to What's New dialog Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Improve wording * Force What's New for next version * Update phpMyAdmin illustration with dot grid background Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Shaun Andrews <shaun@automattic.com> * Refactor and clean up site deletion logic in app (#2915) * Refactor site deletion in app * Nit fix * [skip ci] Bump version to 1.7.7-beta3 * Emit `deleted` site event when removing empty site (#2929) * Bump CLI version * [skip ci] Update translations * [skip ci] Bump version to 1.7.7 * [skip ci] Bump CLI version to 1.7.7 --------- Co-authored-by: Roberto Aranda <roberto.aranda@automattic.com> Co-authored-by: Shaun Andrews <shaun@automattic.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Wojtek Naruniec <wojtek@naruniec.me> Co-authored-by: katinthehatsite <katerynakodonenko@gmail.com> Co-authored-by: Kateryna Kodonenko <kateryna@automattic.com> Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com> Co-authored-by: Gergely Csécsey <gergely.csecsey@automattic.com> Co-authored-by: Ivan Ottinger <ivan.ottinger@automattic.com> Co-authored-by: Bernardo Cotrim <bmmcotrim@gmail.com> Co-authored-by: Fredrik Rombach Ekelund <fredrik@f26d.dev> Co-authored-by: Antonio Sejas <antonio.sejas@automattic.com> Co-authored-by: Wojtek Naruniec <wojtek.naruniec@automattic.com>
fredrikekelund
added a commit
that referenced
this pull request
Apr 2, 2026
* [skip ci] Code freeze: Update translatable strings for 1.7.7 * [skip ci] Code freeze: Add draft release notes for 1.7.7 * Fix Prettier lint error in ipc-handlers import statement (#2893) * Update Studio CLI settings toggle copy and layout (#2855) * Update Studio CLI toggle copy and layout Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix unit tests to follow UI change --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Wojtek Naruniec <wojtek@naruniec.me> * Studio: Borders don't have correct colors in dark mode (#2885) * Add rule for buttons borders * Improve comment --------- Co-authored-by: Kateryna Kodonenko <kateryna@automattic.com> * [skip ci] Update translations * [skip ci] Bump version to 1.7.7-beta1 * Update CLI version * Preliminary release notes cleanup * Fix: CLI doesn't generate site thumbnails (#2850) * Consolidate thumbnail capture to shared CLI path Create a single thumbnail capture path through captureSiteThumbnail() that is used by both the desktop UI (loadThemeDetails) and CLI events subscriber. This eliminates duplication and uses pendingCaptures deduplication to prevent concurrent BrowserWindow creation when the same site is captured by multiple paths simultaneously. * remove comments * Use sequential util with deduplicateKey for thumbnail capture * Fix E2E copy-site test targeting wrong BrowserWindow The thumbnail capture feature creates hidden BrowserWindows for screenshots. The copy-site test used getAllWindows()[0] to send the IPC event, which could target the screenshot window instead of the main app window, causing the copy action to silently fail. Use getFocusedWindow() with a visible-window fallback instead. --------- Co-authored-by: katinthehatsite <katerynakodonenko@gmail.com> * Disable Redis/memcached when JSPI is unavailable (#2900) * Disable Redis and memcached PHP extensions when JSPI is unavailable These extensions require JSPI (JavaScript Promise Integration), which is only available in Node.js 24+. On Node <24, enabling them crashes the WordPress server at startup. This conditionally disables them when JSPI isn't available, matching the pattern in process-manager-daemon.ts. Also bumps the minimum engine version to >=24.0.0 since the production build strips asyncify binaries, making Node 24+ a de facto requirement. * Revert engine version bump to >=22.0.0 * Sort sites by sortOrder when loading from IPC (#2902) * Fix regressions around deleting preview sites (#2903) * Support deleting all preview sites from CLI and app * Update tests * Fix * Improve schemas and types * Tweak * Fix JSPI detection using runtime feature check (#2906) * Fix JSPI detection using runtime feature check instead of Node version Replace semver.gte(process.version, '24.0.0') with a runtime check for WebAssembly.promising to detect JSPI availability. The version check assumed Node 24+ has JSPI enabled by default, but it requires the --experimental-wasm-jspi flag. This caused "Redis extension requires JSPI" errors when running CLI commands directly without the flag. Extract the check into a shared isJspiAvailable helper in tools/common/lib/jspi.ts so there is a single source of truth. * Remove unverified claim about JSPI proposal stage from comment * Fix linting * Address review suggestions * Pass `--experimental-wasm-jspi` to node in bin script --------- Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com> * [skip ci] Update translations * [skip ci] Bump version to 1.7.7-beta2 * Minuscule CLI README tweak (#2917) * Minuscule CLI README tweak * Fix tests * Address review comments * Rename `appdata-v1.json` to `appdata-v1.deprecated.json` (#2916) * Rename `appdata-v1.json` to `appdata-v1.deprecated.json` * Fix tests * Fix tests * Fix tests * Fix What's New current step icon color in dark mode (#2921) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update release notes for 1.7.7 (#2905) * Update release notes for 1.7.7 * Address review suggestions * Ensure that language packs are bundled in `wp-files` (#2922) * Add phpMyAdmin to What's New dialog (#2920) * Add phpMyAdmin to What's New dialog Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Improve wording * Force What's New for next version * Update phpMyAdmin illustration with dot grid background Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Shaun Andrews <shaun@automattic.com> * Refactor and clean up site deletion logic in app (#2915) * Refactor site deletion in app * Nit fix * [skip ci] Bump version to 1.7.7-beta3 * Emit `deleted` site event when removing empty site (#2929) * Bump CLI version * [skip ci] Update translations * [skip ci] Bump version to 1.7.7 * [skip ci] Bump CLI version to 1.7.7 --------- Co-authored-by: Roberto Aranda <roberto.aranda@automattic.com> Co-authored-by: Shaun Andrews <shaun@automattic.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Wojtek Naruniec <wojtek@naruniec.me> Co-authored-by: katinthehatsite <katerynakodonenko@gmail.com> Co-authored-by: Kateryna Kodonenko <kateryna@automattic.com> Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com> Co-authored-by: Gergely Csécsey <gergely.csecsey@automattic.com> Co-authored-by: Ivan Ottinger <ivan.ottinger@automattic.com> Co-authored-by: Bernardo Cotrim <bmmcotrim@gmail.com> Co-authored-by: Fredrik Rombach Ekelund <fredrik@f26d.dev> Co-authored-by: Antonio Sejas <antonio.sejas@automattic.com> Co-authored-by: Wojtek Naruniec <wojtek.naruniec@automattic.com>
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
4 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.
Related issues
How AI was used in this PR
N/A
Proposed Changes
apps/cli/README.md(which is what shows up on npm) about how the Studio CLI integrates with external AI coding agents.Testing Instructions
Just review the diff
Pre-merge Checklist