clerk-nuxt-patterns — Claude Code skill: what it does, how to install
Provides @clerk/nuxt authentication patterns for Nuxt 3 projects. It helps configure Nitro server routes, client composables, and SSR route guards.
npx skills add clerk/skills --skill clerk-nuxt-patterns -a claude-codeWhat clerk-nuxt-patterns does
This skill guides agents through implementing @clerk/nuxt inside Nuxt 3 applications. It covers route protection using definePageMeta({ middleware: 'auth' }), client-side state with useAuth, and organization switching components. Auto-imports eliminate manual import boilerplate.
For backend logic, the skill shows how to access session data through event.context.auth and @clerk/nuxt/server. It addresses common SSR hydration pitfalls when rendering user status. Note that Nuxt ignores keys missing the NUXT_PUBLIC_ prefix, so misconfigured environment variables will silently break client authentication.
What it helps with
- protect Nuxt 3 pages with the built-in auth middleware
- access session auth inside Nitro server routes via event.context.auth
- prevent SSR hydration mismatches when checking authentication status
- manage organization roles and context using useAuth
Example prompts for the agent
- Show how to protect a dashboard page using Clerk auth middleware in Nuxt 3
- How do I read auth state in a Nitro server route with @clerk/nuxt?
- Set up an org-aware component checking orgId and orgRole with useAuth
How to install clerk-nuxt-patterns
1Skills CLI (Vercel)
npx skills add clerk/skills --skill clerk-nuxt-patterns -a claude-code2Manually: put the files in place
~/.claude/skills/clerk-nuxt-patterns/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/clerk-nuxt-patterns/
1Skills CLI (Vercel)
npx skills add clerk/skills --skill clerk-nuxt-patterns -a codex2Manually: put the files in place
.agents/skills/clerk-nuxt-patterns/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add clerk/skills --skill clerk-nuxt-patterns -a cursor2Manually: put the files in place
.cursor/skills/clerk-nuxt-patterns/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install clerk/skills clerk-nuxt-patterns2Manually: put the files in place
.github/skills/clerk-nuxt-patterns/SKILL.md1Skills CLI (Vercel)
npx skills add clerk/skills --skill clerk-nuxt-patterns -a gemini-cli2Platform CLI
gemini skills install https://github.com/clerk/skills --path skills/clerk-nuxt-patternsManually: put the files in place
.devin/skills/clerk-nuxt-patterns/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add clerk/skills --skill clerk-nuxt-patterns -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about clerk-nuxt-patterns
How to install clerk-nuxt-patterns in Claude Code?
Run npx skills add clerk/skills --skill clerk-nuxt-patterns -a claude-code.
What does clerk-nuxt-patterns do?
It teaches coding agents the correct implementation patterns for @clerk/nuxt, including route middleware, composables, and Nitro server endpoints.
Why does useAuth return undefined on the server?
The useAuth composable is client-only. For Nitro server routes, read auth data from event.context.auth or import clerkClient from @clerk/nuxt/server.
Source text
SKILL.md · MIT
---
name: clerk-nuxt-patterns
description: 'Nuxt 3 auth patterns with @clerk/nuxt - middleware, composables, server
API routes, SSR. Triggers on: Nuxt auth, useAuth composable, clerkMiddleware Nuxt,
server API Clerk, Nuxt route protection.'
license: MIT
allowed-tools: WebFetch
metadata:
author: clerk
version: 1.0.0
---
# Nuxt Patterns
## What Do You Need?
| Task | Reference |
|------|-----------|
| Protect routes with middleware | references/nuxt-middleware.md |
| Auth in server API routes (Nitro) | references/server-api-routes.md |
| useAuth / useUser in components | references/composables.md |
| SSR-safe auth patterns | references/ssr-auth.md |
## References
| Reference | Description |
|-----------|-------------|
| `references/nuxt-middleware.md` | Route protection, clerkMiddleware() |
| `references/server-api-routes.md` | Nitro server route auth |
| `references/composables.md` | useAuth, useUser, useClerk |
| `references/ssr-auth.md` | SSR hydration, server vs client |
## Setup
```
npm install @clerk/nuxt
```
`.env`:
```
NUXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_...
NUXT_CLERK_SECRET_KEY=sk_...
```
`nuxt.config.ts`:
```typescript
export default defineNuxtConfig({
modules: ['@clerk/nuxt'],
})
```
This single line auto-configures middleware, plugins, and component auto-imports.
## Mental Model
`@clerk/nuxt` auto-imports all Clerk components and composables — no explicit imports needed in `<script setup>`.
- **Composables** (`useAuth`, `useUser`) — client-side reactive, inside `<script setup>`
- **Server routes** (`clerkClient`) — Nitro server routes, `event.context.auth`
- **Middleware** (`clerkMiddleware`) — auto-registered, use `auth().protect()` to lock routes
## Minimal Pattern
```vue
<!-- pages/dashboard.vue -->
<script setup lang="ts">
definePageMeta({ middleware: 'auth' })
const { userId } = useAuth()
</script>
<template>
<Show when="signed-in">
<p>Hello {{ userId }}</p>
</Show>
</template>
```
> `definePageMeta({ middleware: 'auth' })` uses the built-in auth middleware from `@clerk/nuxt`.
## Common Pitfalls
| Symptom | Cause | Fix |
|---------|-------|-----|
| Composables return `undefined` on server | useAuth is client-only | Use `event.context.auth` in server routes |
| Route not protected | Missing `middleware: 'auth'` meta | Add `definePageMeta({ middleware: 'auth' })` |
| `clerkClient` not available | Wrong import path | Import from `@clerk/nuxt/server` |
| Hydration mismatch | Rendering auth state before mounted | Wrap in `<ClientOnly>` or check `isLoaded` |
| Env vars not picked up | Wrong prefix | Nuxt requires `NUXT_PUBLIC_` for public, `NUXT_` for server |
## Org-Aware Pattern
```vue
<script setup lang="ts">
const { orgId, orgRole } = useAuth()
</script>
<template>
<div v-if="orgId">
<p>Org: {{ orgId }}</p>
<p v-if="orgRole === 'org:admin'">Admin panel</p>
</div>
<div v-else>
<OrganizationSwitcher />
</div>
</template>
```
## See Also
- `clerk-setup` - Initial Clerk install
- `clerk-custom-ui` - Custom flows & appearance
- `clerk-orgs` - B2B organizations
## Docs
[Nuxt SDK](https://clerk.com/docs/nuxt/getting-started/quickstart)
© clerk · MIT · clerk/skills