Installation

Install vuqs with your package manager of choice:

pnpm

pnpm add @vuqs/core

npm

npm install @vuqs/core

yarn

yarn add @vuqs/core

bun

bun add @vuqs/core

Requirements

Requirement	Version	Notes
Vue	>=3.5	Built on the current reactivity APIs.
vue-router	4 || 5	Optional peer dependency, used only by the built-in adapter.
Node	>=22	For local development. ESM-only, no CommonJS build.

Most apps already have vue-router, so the built-in adapter needs nothing extra.

Using Nuxt?

@vuqs/nuxt wraps the core: it provides the vue-router adapter app-wide and auto-imports the composables and codecs.

Next

The core never touches the URL on its own. Set up an adapter so vuqs can read the query and navigate, then bind your first query state.