create-breakdance-wp

Scaffold a local Breakdance + WordPress site with AI agents — powered by Katalyst.

One command asks two questions (site name and which AI agents to install), sets everything up — WordPress + MariaDB + an isolated agent workspace, with Breakdance installed and activated — and lands you on the Katalyst menu: one-click logged-in wp-admin, launch an agent, sandbox shell.

Usage

# npm create form:
npm create breakdance-wp@latest

# or directly with npx:
npx create-breakdance-wp

# fully non-interactive:
npx create-breakdance-wp my-site --agents=claude --yes

Docker must be running. When it finishes you have a live Breakdance site with generated admin credentials shown on screen (and saved in the project's .env). Day to day, from the project directory:

npm run katalyst   # the Katalyst menu — starts the site, wp-admin, agents, shell

What you get

Everything from create-katalystwp — WordPress + your choice of AI agents (Claude Code, Cursor CLI, Codex, OpenCode) + the WordPress & Playwright MCP servers — plus Breakdance, installed and activated during setup. All flags (--port=, --agents=, --plugins=, --yes, --scaffold-only, …), the environments list (npx create-breakdance-wp list), and the built-in updater are inherited from Katalyst.

Requirements

• Node.js >= 18 (to run the CLI and the project's npm scripts)
• Docker with Compose v2 (to actually run the environment)

License

GPL-2.0-or-later