woocommerce-local-env

Imported from woocommerce/woocommerce (.ai/skills/woocommerce-local-env/SKILL.md). Install upstream with npx skills add woocommerce/woocommerce --skill woocommerce-local-env. Copyright stays with the author.

WooCommerce Local Environment

Overview

Use this skill to get WooCommerce Core running locally without re-reading plugins/woocommerce/README.md and .wp-env.json.

Prefer short root scripts when present. Fall back to filtered package commands if the aliases are not available.

Process Ownership

Use this ownership model when deciding whether to run a command or tell the user what to run:

• Run setup checks, dependency installs, one-shot builds, and wp-env start/stop commands from the agent when useful for the task. These commands should complete and return control.
• Treat watch:* commands as user-owned long-running processes. Tell the user to run the relevant watcher in a separate terminal unless a short, temporary watcher session is explicitly needed for active verification.
• Reuse an already-running environment when possible.
• Stop or clean up any agent-owned long-running session before finishing.

Quick Commands

Run these from the repository root:

# Start the wp-env development environment at http://localhost:8888/.
pnpm wc:env

# Stop or restart wp-env.
pnpm wc:env:stop
pnpm wc:env:restart

# Watch all WooCommerce Core build outputs.
pnpm wc:watch

# Watch targeted build outputs.
pnpm wc:watch:admin
pnpm wc:watch:blocks
pnpm wc:watch:classic-assets

# Build all or targeted outputs once.
pnpm wc:build
pnpm wc:build:admin
pnpm wc:build:blocks
pnpm wc:build:classic-assets

pnpm wc:env:restart destroys and recreates the wp-env containers, so use it only when a clean restart is intended.

Fallback commands from the WooCommerce package:

pnpm --filter='@woocommerce/plugin-woocommerce' env:dev
pnpm --filter='@woocommerce/plugin-woocommerce' env:stop
pnpm --filter='@woocommerce/plugin-woocommerce' env:restart
pnpm --filter='@woocommerce/plugin-woocommerce' build
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build:admin
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build:blocks
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build:classic-assets

From plugins/woocommerce/, run the package scripts directly, for example pnpm env:dev or pnpm watch:build.

Setup Workflow

1. Check prerequisites when setup fails or when the user asks for first-time setup:

   node --version
   pnpm --version
   php --version
   composer --version
   docker --version
   docker info

2. Install dependencies from the repository root only when dependencies are missing or stale:

   pnpm install

3. Start the environment:

   pnpm wc:env

4. Tell the user to start a watcher in a separate terminal if frontend or asset changes need live rebuilds:

   pnpm wc:watch

Recommend targeted watchers for focused work to reduce noise and startup time:

• Admin client: pnpm wc:watch:admin
• Blocks client: pnpm wc:watch:blocks
• Classic assets: pnpm wc:watch:classic-assets

Environment Details

• Development URL: http://localhost:8888/
• Test environment port: 8086
• wp-env config: plugins/woocommerce/.wp-env.json
• wp-env PHP version: 8.1
• WooCommerce package: @woocommerce/plugin-woocommerce
• Source README: plugins/woocommerce/README.md

Verification

After starting wp-env, verify the site responds:

curl -I http://localhost:8888/

For browser-based verification, open http://localhost:8888/ with the Browser plugin when the user asks to inspect or test the local site.

Troubleshooting

• If docker info fails, ask the user to start Docker Desktop and retry.
• If pnpm wc:env fails after dependency changes, run pnpm install, then retry.
• If wp-env containers look stale, run pnpm wc:env:restart only after confirming a destructive environment reset is acceptable.
• If assets do not update, confirm the relevant watcher is running and use a targeted watcher for the changed area.
• If the user only needs PHP unit tests, prefer the test commands from woocommerce-dev-cycle; do not start a full browser workflow unless needed.