---
title: "Guide"
description: "Learn the shared Vue runtime for Convex: plugin setup, query and mutation patterns, pagination, storage, auth, and advanced runtime control."
canonical_url: "https://nuxt-convex.onmax.me/vue-guide"
---
# Guide

> Learn the shared Vue runtime for Convex: plugin setup, query and mutation patterns, pagination, storage, auth, and advanced runtime control.

This section is the task-focused guide for `vue-convex`. Use it when you want to build with the shared Vue runtime or understand the behavior that also sits underneath the Nuxt module.

## Read this section in order if you are new

1. [Installation](https://nuxt-convex.onmax.me/vue-guide/installation)
2. [Queries](https://nuxt-convex.onmax.me/vue-guide/queries)
3. [Mutations & Actions](https://nuxt-convex.onmax.me/vue-guide/mutations-and-actions)
4. [Pagination](https://nuxt-convex.onmax.me/vue-guide/pagination)

Then branch into:

- [File Storage](https://nuxt-convex.onmax.me/vue-guide/file-storage)
- [Controller](https://nuxt-convex.onmax.me/vue-guide/controller)
- [Authentication](https://nuxt-convex.onmax.me/vue-guide/authentication)
- [Connection State](https://nuxt-convex.onmax.me/vue-guide/connection-state)
- [Server Rendering](https://nuxt-convex.onmax.me/vue-guide/server-rendering), only if you run your own SSR

## Read by task

<card-group>
<card icon="i-lucide-download" title="Install and verify" to="https://nuxt-convex.onmax.me/vue-guide/installation">

Register the plugin and run the first query.

</card>

<card icon="i-lucide-search" title="Subscribe to data" to="https://nuxt-convex.onmax.me/vue-guide/queries">

Use reactive arguments, `status` and errors, auth modes and skip logic.

</card>

<card icon="i-lucide-list" title="Build paginated feeds" to="https://nuxt-convex.onmax.me/vue-guide/pagination">

Load more results, reset on filter changes, and use optimistic helpers.

</card>

<card icon="i-lucide-sliders-horizontal" title="Manage the connection" to="https://nuxt-convex.onmax.me/vue-guide/controller">

Connect later, reconfigure the runtime, or work with the raw clients.

</card>
</card-group>

## Related sections

- Read [Convex Patterns](https://nuxt-convex.onmax.me/convex-patterns) for the backend model behind these guides
- Read [API Reference](https://nuxt-convex.onmax.me/api-reference) when you need exact signatures instead of walkthroughs


## Sitemap

See the full [sitemap](https://nuxt-convex.onmax.me/sitemap.md) for all pages.
