Nuxt

Use nuxt-convex in a Nuxt app for module setup, auto-imports, virtual modules, storage scaffolding, and Nuxt-side integrations.

Use this track when your app runs on Nuxt and you want the framework wrapper around the shared Vue runtime.

nuxt-convex owns the Nuxt-facing contract:

  • module registration
  • #convex/* aliases
  • auto-imports
  • generated API access through #convex/api
  • optional storage scaffolding
  • Nuxt-side Better Auth and Cloudflare R2 integrations

For shared composable behavior such as queries, mutations, pagination, and auth state, read the Vue track. In a Nuxt app, keep the Nuxt import paths and aliases.

Start with the Nuxt path

Open the page that matches your job: install the module, configure its public surface, or add a Nuxt-specific integration.

Install the module
Add nuxt-convex, generate the API, and verify your first query.
Configure the Nuxt layer
Learn the module config, aliases, auto-imports, storage scaffolding, and wrapper-specific behavior.
Add integrations
Wire Better Auth or Cloudflare R2 through the supported Nuxt-side entrypoints.
Look up the public API
Check config keys, aliases, components, and the Nuxt-only upload helper.

What stays shared

The Nuxt module does not replace the shared data layer. These behaviors still come from the underlying Vue package:

  • query and multi-query subscriptions
  • mutations and actions
  • paginated queries
  • auth state primitives
  • connection-state tracking
  • the advanced controller and raw client helpers

Next step

Open Nuxt Module for the wrapper contract, or go straight to Integrations if you already have the core module installed.

Copyright © 2026