Getting Started
Installation
Get WPNuxt running in 2 minutes
Quick Start (Recommended)
The fastest way to get started is with the WPNuxt starter template. It creates a fully configured project with Nuxt UI, menus, dynamic pages, and a WordPress Playground for local development.
npm create wpnuxt@latest
pnpm create wpnuxt@latest
yarn create wpnuxt@latest
bun create wpnuxt@latest
The CLI will prompt you for a project name, WordPress URL, and package manager. Once complete, run:
pnpm dev:blueprint
This starts a local WordPress Playground with sample content and launches the Nuxt dev server — no WordPress installation required.
Already have a WordPress site? Skip the blueprint and run
pnpm dev instead, after setting WPNUXT_WORDPRESS_URL in your .env file.Manual Installation
If you already have a Nuxt project and want to add WPNuxt to it:
Requirements
- Nuxt 3.17+
- Node.js 20+
- WordPress with WPGraphQL plugin
Install
pnpm add @wpnuxt/core
npm install @wpnuxt/core
yarn add @wpnuxt/core
Configure
nuxt.config.ts
export default defineNuxtConfig({
modules: ['@wpnuxt/core'],
wpNuxt: {
wordpressUrl: 'https://your-wordpress-site.com'
}
})
Or use environment variables:
.env
WPNUXT_WORDPRESS_URL=https://your-wordpress-site.com
Verify
Run the dev server:
pnpm dev
If you see "WPNuxt module loaded" in the console, you're ready to go.
Next Steps
- Set up WordPress - Configure WPGraphQL
- Fetch data - Start using composables
- CLI Reference - Learn about
wpnuxi infoandwpnuxi doctor