---
title: "Installation"
description: "Get WPNuxt running in 2 minutes"
canonical_url: "https://wpnuxt.com/getting-started/installation"
---
# 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.

<code-group>

```bash [npm]
npm create wpnuxt@latest
```

```bash [pnpm]
pnpm create wpnuxt@latest
```

```bash [yarn]
yarn create wpnuxt@latest
```

```bash [bun]
bun create wpnuxt@latest
```

</code-group>

The CLI will prompt you for a project name, WordPress URL, and package manager. Once complete, run:

```bash
pnpm dev:blueprint
```

This starts a local WordPress Playground with sample content and launches the Nuxt dev server — no WordPress installation required.

<callout type="tip">

Already have a WordPress site? Skip the blueprint and run `pnpm dev` instead, after setting `WPNUXT_WORDPRESS_URL` in your `.env` file.

</callout>

## Manual Installation

If you already have a Nuxt project and want to add WPNuxt to it:

### Requirements

- Nuxt 4.1+
- Node.js 20+
- WordPress with [WPGraphQL](https://wordpress.org/plugins/wp-graphql/) plugin

### Install

<code-group>

```bash [pnpm]
pnpm add @wpnuxt/core
```

```bash [npm]
npm install @wpnuxt/core
```

```bash [yarn]
yarn add @wpnuxt/core
```

</code-group>

### Configure

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  modules: ['@wpnuxt/core'],

  wpNuxt: {
    wordpressUrl: 'https://your-wordpress-site.com'
  }
})
```

Or use environment variables:

```bash [.env]
WPNUXT_WORDPRESS_URL=https://your-wordpress-site.com
```

### Verify

Run the dev server:

```bash
pnpm dev
```

If you see "WPNuxt module loaded" in the console, you're ready to go.

## Next Steps

- [Set up WordPress](https://wpnuxt.com/getting-started/wordpress-setup) - Configure WPGraphQL
- [Fetch data](https://wpnuxt.com/guide/fetching-data) - Start using composables
- [CLI Reference](https://wpnuxt.com/reference/cli) - Learn about `wpnuxi info` and `wpnuxi doctor`


## Sitemap

See the full [sitemap](https://wpnuxt.com/sitemap.md) for all pages.