mcpField
C
clerk-vue-patterns

clerk-vue-patterns

github.com/midudevDevelopment7.0k57 installsUpdated 1w ago
Repository

About clerk-vue-patterns

A reference skill for developers building Vue 3 apps with `@clerk/vue` v2+. It organizes authentication, organization, and Vue Router patterns alongside setup guidance and common pitfalls.

Key features

  1. 01Reactive auth and user composables
  2. 02Organization state and switching
  3. 03Vue Router navigation guards
  4. 04Pinia auth-state integration
  5. 05Setup guidance and troubleshooting

Use cases

  1. 01Adding Clerk authentication to a Vue 3 app
  2. 02Reading signed-in user or organization state
  3. 03Protecting routes with Vue Router
  4. 04Connecting auth state to Pinia

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/midudev/autoskills --skill clerk-vue-patterns

After installing, type/clerk-vue-patternsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

evals/
evals.json
references/
composables.md
pinia-integration.md
vue-router-guards.md
templates/vue-basic-auth/
index.html
package.json
vite.config.ts
templates/vue-basic-auth/src/
App.vue
main.ts
style.css

Details

From the project README

Vue Patterns

SDK: @clerk/vue v2+ (Vue 3). For Nuxt, use clerk-nuxt-patterns.

What Do You Need?

TaskReference
Composables: useAuth, useUser, useOrganizationreferences/composables.md
Vue Router navigation guardsreferences/vue-router-guards.md
Pinia store with auth statereferences/pinia-integration.md

Mental Model

Vue uses composables from @clerk/vue:

  • useAuth() — reactive isSignedIn, userId, signOut
  • useUser() — reactive user object
  • useClerk() — full Clerk instance for advanced operations
  • useOrganization() — reactive organization, membership

Setup

Vue (Plain)
// main.ts
import { clerkPlugin } from '@clerk/vue'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)
app.use(clerkPlugin, {
  publishableKey: import.meta.env.VITE_CLERK_PUBLISHABLE_KEY,
})
app.mount('#app')

Composables Usage

<script setup lang="ts">
import { useAuth, useUser } from '@clerk/vue'

const { isSignedIn, userId, signOut } = useAuth()
const { user } = useUser()
</script>

<template>
  <div v-if="isSignedIn">
    <p>Hello {{ user?.firstName }}</p>
    <button @click="signOut()">Sign Out</button>
  </div>
  <SignInButton v-else />
</template>

Org Switching

<script setup lang="ts">
import { useOrganizationList } from '@clerk/vue'

const { userMemberships, setActive } = useOrganizationList()
</script>

<template>
  <button
    v-for="mem in userMemberships.data ?? []"
    :key="mem.organization.id"
    @click="setActive({ organization: mem.organization.id })"
  >
    {{ mem.organization.name }}
  </button>
</template>

Common Pitfalls

SymptomCauseFix
Composables return undefinedNot inside ClerkProvider treeEnsure app.use(clerkPlugin, { publishableKey }) is called
userId reactive but not updatingDestructuring loses reactivityUse const { userId } = useAuth() (toRefs-style composable, reactive)

Import Map

WhatImport
Composables@clerk/vue
Plugin setup@clerk/vue
Components@clerk/vue

See Also

  • clerk-setup - Initial Clerk install
  • clerk-custom-ui - Custom flows & appearance
  • clerk-orgs - B2B organizations

Docs

Comments

Markdown supported