clerk-setup
Original:🇺🇸 English
Translated
Add Clerk authentication to any project by following the official quickstart guides.
6installs
Sourceclerk/skills
Added on
NPX Install
npx skill4agent add clerk/skills clerk-setupTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Adding Clerk
This skill sets up Clerk for authentication by following the official quickstart documentation.
Quick Reference
| Step | Action |
|---|---|
| 1. Detect framework | Check |
| 2. Fetch quickstart | Use WebFetch on the appropriate docs URL |
| 3. Follow instructions | Execute the steps from the official guide |
| 4. Get API keys | From dashboard.clerk.com |
Framework Detection
Check to identify the framework:
package.json| Dependency | Framework | Quickstart URL |
|---|---|---|
| Next.js | |
| Remix | |
| Astro | |
| Nuxt | |
| React Router | |
| TanStack Start | |
| React SPA | |
| Vue | |
| Express | |
| Fastify | |
| Expo | |
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-stepSetup Process
1. Detect the Framework
Read the project's and match dependencies to the table above.
package.json2. 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 or
pk_test_pk_live_ - Secret Key: Starts with or
sk_test_sk_live_ - Set as environment variables: and
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEYCLERK_SECRET_KEY
Migrating from Another Auth Provider
If the project already has authentication, create a migration plan before replacing it.
Detect Existing Auth
Check for existing auth libraries:
package.json- /
next-auth→ NextAuth/Auth.js@auth/core - → Supabase Auth
@supabase/supabase-js - /
firebase→ Firebase Authfirebase-admin - → AWS Cognito
@aws-amplify/auth - /
auth0→ Auth0@auth0/nextjs-auth0 - → Passport.js
passport - Custom JWT/session implementation
Migration Process
-
Audit current auth - Identify all auth touchpoints:
- Sign-in/sign-up pages
- Session/token handling
- Protected routes and middleware
- User data storage (database tables, external IDs)
- OAuth providers configured
-
Create migration plan - Consider:
- User data export - Export users and import via Clerk's Backend API
- Password hashes - Clerk can upgrade hashes to Bcrypt transparently
- External IDs - Store legacy user IDs as in Clerk
external_id - Session handling - Existing sessions will terminate on switch
-
Choose migration strategy:
- Big bang - Switch all users at once (simpler, requires maintenance window)
- Trickle migration - Run both systems temporarily (lower risk, higher complexity)
Migration Reference
- Migration Overview: https://clerk.com/docs/guides/development/migrating/overview
Common Pitfalls
| Level | Issue | Solution |
|---|---|---|
| CRITICAL | Missing | In Next.js 15+, |
| CRITICAL | Exposing | Never use secret key in client code; only |
| HIGH | Missing middleware matcher | Include API routes: `matcher: ['/((?!.\.. |
| HIGH | ClerkProvider not at root | Must wrap entire app in root layout/App component |
| HIGH | Auth routes not public | Allow |
| HIGH | Landing page requires auth | To keep "/" public, exclude it: `matcher: ['/((?!.\.. |
| MEDIUM | Wrong import path | Server code uses |
See Also
- - Custom sign-in/up components
custom-flows/ - - Webhook → database sync
syncing-users/ - - B2B multi-tenant organizations
managing-orgs/ - - E2E testing setup
testing/ - - Advanced Next.js patterns
nextjs-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