name: clerk-setup
description: Add Clerk authentication to any project by following the official quickstart guides.
license: MIT
allowed-tools: WebFetch
metadata:
author: clerk
version: "1.0.0"

Adding Clerk

This skill sets up Clerk for authentication by following the official quickstart documentation.

Quick Reference

Framework Detection

Check package.json to identify the framework:

For other platforms:
- Chrome Extension: https://clerk.com/docs/chrome-extension/getting-started/quickstart
- Android: https://clerk.com/docs/android/getting-started/quickstart
- iOS: https://clerk.com/docs/ios/getting-started/quickstart
- Vanilla JavaScript: https://clerk.com/docs/js-frontend/getting-started/quickstart

Decision Tree

User Request: "Add Clerk" / "Add authentication"
    │
    ├─ Read package.json
    │
    ├─ Existing auth detected?
    │   │
    │   ├─ YES → Audit current auth → Create migration plan
    │   │        → See "Migrating from Another Auth Provider"
    │   │
    │   └─ NO → Fresh install
    │
    ├─ Identify framework from dependencies
    │
    ├─ WebFetch the appropriate quickstart URL
    │
    └─ Follow the official instructions step-by-step

Setup Process

1. Detect the Framework

Read the project's package.json and match dependencies to the table above.

2. Fetch the Quickstart Guide

Use WebFetch to retrieve the official quickstart for the detected framework:

WebFetch: https://clerk.com/docs/{framework}/getting-started/quickstart
Prompt: "Extract the complete setup instructions including all code snippets, file paths, and configuration steps."

3. Follow the Instructions

Execute each step from the quickstart guide:
- Install the required packages
- Set up environment variables
- Add the provider/middleware
- Create sign-in/sign-up routes if needed
- Test the integration

4. Get API Keys

Two paths for development API keys:

Keyless (Automatic)
- On first SDK initialization, Clerk auto-generates dev keys and shows "Claim your application" popover
- No manual key setup required—keys are created and injected automatically
- Simplest path for new projects

Manual (Dashboard)
- Get keys from dashboard.clerk.com if Keyless doesn't trigger
- Publishable Key: Starts with pk_test_ or pk_live_
- Secret Key: Starts with sk_test_ or sk_live_
- Set as environment variables: NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY

Migrating from Another Auth Provider

If the project already has authentication, create a migration plan before replacing it.

Detect Existing Auth

Check package.json for existing auth libraries:
- next-auth / @auth/core → NextAuth/Auth.js
- @supabase/supabase-js → Supabase Auth
- firebase / firebase-admin → Firebase Auth
- @aws-amplify/auth → AWS Cognito
- auth0 / @auth0/nextjs-auth0 → Auth0
- passport → Passport.js
- Custom JWT/session implementation

Migration Process

1. Audit current auth - Identify all auth touchpoints:
2. Sign-in/sign-up pages
3. Session/token handling
4. Protected routes and middleware
5. User data storage (database tables, external IDs)

6. OAuth providers configured

7. Create migration plan - Consider:

8. User data export - Export users and import via Clerk's Backend API
9. Password hashes - Clerk can upgrade hashes to Bcrypt transparently
10. External IDs - Store legacy user IDs as external_id in Clerk

11. Session handling - Existing sessions will terminate on switch

12. Choose migration strategy:

13. Big bang - Switch all users at once (simpler, requires maintenance window)
14. Trickle migration - Run both systems temporarily (lower risk, higher complexity)

Migration Reference

• Migration Overview: https://clerk.com/docs/guides/development/migrating/overview

Common Pitfalls

See Also

• custom-flows/ - Custom sign-in/up components
• syncing-users/ - Webhook → database sync
• managing-orgs/ - B2B multi-tenant organizations
• testing/ - E2E testing setup
• nextjs-patterns/ - Advanced Next.js patterns

Documentation

• Quickstart Overview: https://clerk.com/docs/getting-started/quickstart/overview
• Migration Guide: https://clerk.com/docs/guides/development/migrating/overview
• Full Documentation: https://clerk.com/docs