Instrument Product Analytics
PostHogOfficialCreated by PostHog
- Skill
- Tool integration
- Data and AI
- MIT
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured, multi-step workflow to integrate PostHog product analytics into a wide variety of software projects. It guides the user through detecting the project's framework, installing the appropriate SDK, initializing the service, and strategically placing event capture calls. The skill emphasizes non-intrusive implementation, requiring that new analytics code be added alongside existing logic without altering the project's fundamental architecture. It also covers user identification, error tracking, and secure environment variable management.
What it does
- Detects the project's framework and language to determine the correct PostHog SDK.
- Handles initial SDK installation and initialization based on framework-specific patterns.
- Identifies key user actions and business-critical events for tracking.
- Implements event capture calls and user identification logic.
- Configures environment variables securely for API tokens and host URLs.
- Verifies the integration and performs targeted linting on modified files.
When to use it
- After implementing new features that require tracking for product analytics.
- When reviewing pull requests to ensure meaningful user behaviors are captured.
- During the initial setup of a new project that needs product analytics.
- When migrating or adding analytics to an existing application.
Advantages
- Supports a broad range of frontend, backend, and mobile frameworks.
- Ensures consistent event naming and property usage across the codebase.
- Prioritizes non-breaking changes and minimal impact on existing code structure.
- Automates the complex setup of environment variables and SDK initialization.
Usage examples
- “Add PostHog analytics to my Next.js project.”
- The agent will analyze the project structure, install the PostHog SDK, initialize it in the appropriate client/server files, and prompt you to identify key events to track.
- “I need to track user signups and errors in my Django backend.”
- The agent will locate your authentication logic, add identify calls, implement exception capture, and ensure the PostHog project tokens are managed via environment variables.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/posthog/instrument-product-analytics/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip instrument-product-analytics.zip -d .agents/skills
Documentation by PostHog
Add PostHog product analytics events
Use this skill to add product analytics events (capture calls) that track meaningful user actions in new or changed code. Use it after implementing features or reviewing PRs to ensure key user behaviors are captured. If PostHog is not yet installed, this skill also covers initial SDK setup. Supports any framework or language.
Supported frameworks and languages: Next.js, React Router, Nuxt, Vue, TanStack Start, SvelteKit, Astro, Angular, Django, Flask, FastAPI, Laravel, PHP, Ruby on Rails, Go, Elixir, Android, iOS, Flutter, React Native, Expo, and more.
Instructions
Follow these steps IN ORDER:
STEP 1: Analyze the codebase and detect the platform.
Look for dependency files (package.json, pubspec.yaml, Podfile, Package.swift, requirements.txt, Gemfile, composer.json, go.mod, mix.exs, etc.) to determine the framework and language.
Look for lockfiles (pnpm-lock.yaml, package-lock.json, yarn.lock, bun.lockb, go.sum, pubspec.lock, Podfile.lock, Package.resolved, mix.lock) to determine the package manager.
Check for existing PostHog setup. If PostHog is already installed and initialized, skip to STEP 5.
STEP 2: Research integration. (Skip if PostHog is already set up.) 2.1. Find the reference file below that matches the detected framework — it is the source of truth for SDK initialization, provider setup, and event capture patterns. Read it now. 2.2. If no reference matches, fall back to your general knowledge and web search. Use posthog.com/docs as the primary search source.
STEP 3: Install the PostHog SDK. (Skip if PostHog is already set up.)
Add the PostHog SDK package for the detected platform. Do not manually edit package.json — use the package manager's install command.
STEP 4: Initialize PostHog. (Skip if PostHog is already set up.)
Follow the framework reference for where and how to initialize. This varies significantly by framework (e.g., instrumentation-client.ts for Next.js 15.3+, AppConfig.ready() for Django, create_app() for Flask).
STEP 5: Plan event tracking.
From the project's file list, select between 10 and 15 files that might have interesting business value for event tracking, especially conversion and churn events.
Also look for files related to login that could be used for identifying users, along with error handling.
Find any existing
posthog.capture()code. Make note of event name formatting. Don't duplicate existing events; supplement them.Track actions only, not pageviews (those can be captured automatically). Exceptions can be made for "viewed"-type events at the top of a conversion funnel.
Server-side events are REQUIRED if the project includes any instrumentable server-side code (API routes, server actions, webhook handlers, payment/checkout completion, authentication endpoints).
STEP 6: Implement event capture.
For each planned event, add
posthog.capture()calls with useful properties.If a file already has existing integration code for other tools or services, don't overwrite or remove that code. Place PostHog code below it.
Do not alter the fundamental architecture of existing files. Make additions minimal and targeted.
You must read a file immediately before attempting to write it.
STEP 7: Identify users.
Add PostHog
identify()calls on the client side during login and signup events. Use the contents of login and signup forms to identify users on submit.If both frontend and backend exist, pass the client-side session and distinct ID using
X-POSTHOG-DISTINCT-IDandX-POSTHOG-SESSION-IDheaders to the server-side code. On the server side, make sure events have a matching distinct ID.
STEP 8: Add error tracking.
Add PostHog exception capture error tracking to relevant files, particularly around critical user flows and API boundaries.
STEP 9: Set up environment variables.
Check if the project already has PostHog environment variables configured (e.g. in
.env,.env.local, or framework-specific env files). If valid values already exist, skip this step.If the PostHog project token is missing, use the PostHog MCP server's
projects-gettool to retrieve the project'sapi_token. If multiple projects are returned, ask the user which project to use. If the MCP server is not connected or not authenticated, ask the user for their PostHog project token instead.For the PostHog host URL: check the
projects-getMCP response for aregionfield —USmaps tohttps://us.i.posthog.com,EUmaps tohttps://eu.i.posthog.com. If the region is not available from the MCP response or from existing project configuration, ask the user: "Are you on PostHog US Cloud or EU Cloud?" Do not assume US Cloud.Write these values to the appropriate env file using the framework's naming convention.
Reference these environment variables in code instead of hardcoding them.
STEP 10: Verify and clean up.
Check the project for errors. Look for type checking or build scripts in package.json.
Ensure any components created were actually used.
Run any linter or prettier-like scripts found in the package.json, but ONLY on the files you have edited or created during this session. Never run formatting or linting across the entire project's codebase.
Reference files
references/EXAMPLE-next-app-router.md- next-app-router example project codereferences/EXAMPLE-next-pages-router.md- next-pages-router example project codereferences/EXAMPLE-react-react-router-6.md- react-react-router-6 example project codereferences/EXAMPLE-react-react-router-7-framework.md- react-react-router-7-framework example project codereferences/EXAMPLE-react-react-router-7-data.md- react-react-router-7-data example project codereferences/EXAMPLE-react-react-router-7-declarative.md- react-react-router-7-declarative example project codereferences/EXAMPLE-nuxt-3-6.md- nuxt-3-6 example project codereferences/EXAMPLE-nuxt-4.md- nuxt-4 example project codereferences/EXAMPLE-vue-3.md- vue-3 example project codereferences/EXAMPLE-react-tanstack-router-file-based.md- react-tanstack-router-file-based example project codereferences/EXAMPLE-react-tanstack-router-code-based.md- react-tanstack-router-code-based example project codereferences/EXAMPLE-tanstack-start.md- tanstack-start example project codereferences/EXAMPLE-sveltekit.md- sveltekit example project codereferences/EXAMPLE-astro-static.md- astro-static example project codereferences/EXAMPLE-astro-view-transitions.md- astro-view-transitions example project codereferences/EXAMPLE-astro-ssr.md- astro-ssr example project codereferences/EXAMPLE-astro-hybrid.md- astro-hybrid example project codereferences/EXAMPLE-angular.md- angular example project codereferences/EXAMPLE-django.md- django example project codereferences/EXAMPLE-flask.md- flask example project codereferences/EXAMPLE-fastapi.md- fastapi example project codereferences/EXAMPLE-python.md- python example project codereferences/EXAMPLE-laravel.md- laravel example project codereferences/EXAMPLE-php.md- php example project codereferences/EXAMPLE-ruby-on-rails.md- ruby-on-rails example project codereferences/EXAMPLE-ruby.md- ruby example project codereferences/EXAMPLE-android.md- android example project codereferences/EXAMPLE-swift.md- swift example project codereferences/EXAMPLE-react-native.md- react-native example project codereferences/EXAMPLE-expo.md- expo example project codereferences/next-js.md- Next.jsreferences/react-router-v6.md- React router v6references/react-router-v7-framework-mode.md- React router v7 framework mode (remix v3)references/react-router-v7-data-mode.md- React router v7 data modereferences/react-router-v7-declarative-mode.md- React router v7 declarative modereferences/nuxt-js-3-6.md- Nuxt.js (v3.0 to v3.6)references/nuxt-js.md- Nuxt.jsreferences/vue-js.md- Vue.jsreferences/tanstack-start.md- Tanstack startreferences/svelte.md- Sveltereferences/astro.md- Astroreferences/angular.md- Angularreferences/django.md- Djangoreferences/flask.md- Flaskreferences/python.md- Pythonreferences/posthog-python.md- PostHog python SDKreferences/dotnet.md- .netreferences/elixir.md- Elixirreferences/go.md- Goreferences/laravel.md- Laravelreferences/php.md- Phpreferences/ruby-on-rails.md- Ruby on railsreferences/ruby.md- Rubyreferences/android.md- Androidreferences/ios.md- Iosreferences/usage.md- Ios SDK usagereferences/configuration.md- Ios SDK configurationreferences/flutter.md- Flutterreferences/react-native.md- React nativereferences/identify-users.md- Identify usersreferences/COMMANDMENTS.md- Framework-specific rules the integration must follow
Each framework reference contains SDK-specific installation, initialization, and usage patterns. Find the one matching the user's stack.
Key principles
Environment variables: Always use environment variables for PostHog keys. Never hardcode them.
Minimal changes: Add PostHog code alongside existing integrations. Don't replace or restructure existing code.
Match the docs: Follow the framework reference's initialization and capture patterns exactly.
Files
- ATTRIBUTION.mdAdded by AutoGineer970 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md9.6 KiB
- references/COMMANDMENTS.md1.5 KiB
- references/EXAMPLE-android.md49.8 KiB
- references/EXAMPLE-angular.md23.1 KiB
- references/EXAMPLE-astro-hybrid.md27.5 KiB
- references/EXAMPLE-astro-ssr.md27.6 KiB
- references/EXAMPLE-astro-static.md19.6 KiB
- references/EXAMPLE-astro-view-transitions.md23.3 KiB
- references/EXAMPLE-django.md30.7 KiB
- references/EXAMPLE-expo.md35.1 KiB
- references/EXAMPLE-fastapi.md40.9 KiB
- references/EXAMPLE-flask.md32.4 KiB
- references/EXAMPLE-laravel.md59.3 KiB
- references/EXAMPLE-next-app-router.md17.6 KiB
- references/EXAMPLE-next-pages-router.md19.1 KiB
- references/EXAMPLE-nuxt-3-6.md22.3 KiB
- references/EXAMPLE-nuxt-4.md28.9 KiB
- references/EXAMPLE-php.md13.0 KiB
- references/EXAMPLE-python.md11.6 KiB
- references/EXAMPLE-react-native.md46.0 KiB
- references/EXAMPLE-react-react-router-6.md13.5 KiB
- references/EXAMPLE-react-react-router-7-data.md20.1 KiB
- references/EXAMPLE-react-react-router-7-declarative.md15.0 KiB
- references/EXAMPLE-react-react-router-7-framework.md32.5 KiB
- references/EXAMPLE-react-tanstack-router-code-based.md19.6 KiB
- references/EXAMPLE-react-tanstack-router-file-based.md18.3 KiB
- references/EXAMPLE-ruby-on-rails.md38.0 KiB
- references/EXAMPLE-ruby.md10.0 KiB
- references/EXAMPLE-sveltekit.md18.6 KiB
- references/EXAMPLE-swift.md18.8 KiB
- references/EXAMPLE-tanstack-start.md29.9 KiB
- references/EXAMPLE-vue-3.md17.9 KiB
- references/android.md33.3 KiB
- references/angular.md16.5 KiB
- references/astro.md15.8 KiB
- references/configuration.md17.2 KiB
- references/django.md14.9 KiB
- references/dotnet.md25.8 KiB
- references/elixir.md17.6 KiB
- references/flask.md8.1 KiB
- references/flutter.md42.8 KiB
- references/go.md20.1 KiB
- references/identify-users.md12.2 KiB
- references/ios.md8.0 KiB
- references/laravel.md13.1 KiB
- references/next-js.md18.3 KiB
- references/nuxt-js-3-6.md11.4 KiB
- references/nuxt-js.md15.1 KiB
- references/php.md23.7 KiB
- references/posthog-python.md69.3 KiB
- references/python.md52.2 KiB
- references/react-native.md59.9 KiB
- references/react-router-v6.md13.6 KiB
- references/react-router-v7-data-mode.md13.5 KiB
- references/react-router-v7-declarative-mode.md13.7 KiB
- references/react-router-v7-framework-mode.md20.2 KiB
- references/ruby-on-rails.md19.7 KiB
- references/ruby.md25.5 KiB
- references/svelte.md14.6 KiB
- references/tanstack-start.md12.8 KiB
- references/usage.md29.2 KiB
- references/vue-js.md13.4 KiB
references/EXAMPLE-nuxt-4.md
PostHog nuxt-4 Example Project
Repository: https://github.com/PostHog/context-mill Path: example-apps/nuxt-4
README.md
PostHog Nuxt 4 example
This is a Nuxt 4 example demonstrating PostHog integration with product analytics, session replay, feature flags, and error tracking.
Nuxt 4 supports the @posthog/nuxt package, which provides automatic PostHog integration with built-in error tracking, source map uploads, and simplified configuration. This is the recommended approach for Nuxt 4+.
For Nuxt 3.0 - 3.6, you must use the posthog-js and posthog-node packages directly instead. See the Nuxt 3.6 example for that approach.
Features
Product Analytics: Track user events and behaviors
Session Replay: Record and replay user sessions
Error Tracking: Automatic error capture on both client and server
Source Maps: Automatic source map uploads when building for production
User Authentication: Demo login system with PostHog user identification
Server-side & Client-side Tracking: Examples of both tracking methods
SSR Support: Server-side rendering with Nuxt 4
Getting Started
1. Install Dependencies
npm install
# or
pnpm install2. Configure Environment Variables
Create a .env file in the root directory:
NUXT_PUBLIC_POSTHOG_PROJECT_TOKEN=your_posthog_project_token
NUXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
# Optional: For source map uploads
PROJECT_ID=your_project_id
PERSONAL_API_KEY=your_personal_api_keyGet your PostHog project token from your PostHog project settings.
For source map uploads, get your project ID from PostHog environment variables and your personal API key from PostHog user API keys (requires organization:read and error_tracking:write scopes).
3. Run the Development Server
npm run dev
# or
pnpm devOpen http://localhost:3000 with your browser to see the app.
Project Structure
├── app/
│ ├── components/
│ │ └── AppHeader.vue # Navigation header with auth state
│ ├── composables/
│ │ └── useAuth.ts # Authentication composable
│ ├── middleware/
│ │ └── auth.ts # Authentication middleware
│ ├── pages/
│ │ ├── index.vue # Home/Login page
│ │ ├── burrito.vue # Demo feature page with event tracking
│ │ └── profile.vue # User profile with error tracking demo
│ ├── utils/
│ │ └── formValidation.ts # Form validation utilities
│ └── app.vue # Root component
├── assets/
│ └── css/
│ └── main.css # Global styles
├── server/
│ ├── api/
│ │ ├── auth/
│ │ │ └── login.post.ts # Login API with server-side tracking
│ │ └── burrito/
│ │ └── consider.post.ts # Burrito consideration API with server-side tracking
│ └── utils/
│ ├── posthog.ts # Server-side PostHog utility
│ └── users.ts # In-memory user storage utilities
├── nuxt.config.ts # Nuxt configuration with PostHog module
└── package.jsonKey Integration Points
Module Configuration (nuxt.config.ts)
Nuxt 4 uses the @posthog/nuxt module for automatic PostHog integration:
export default defineNuxtConfig({
modules: ['@posthog/nuxt'],
runtimeConfig: {
public: {
posthog: {
publicKey: process.env.NUXT_PUBLIC_POSTHOG_PROJECT_TOKEN || '',
host: process.env.NUXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com',
},
},
},
posthogConfig: {
publicKey: process.env.NUXT_PUBLIC_POSTHOG_PROJECT_TOKEN || '',
host: process.env.NUXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com',
clientConfig: {
capture_exceptions: true, // Enables automatic exception capture on the client side (Vue)
tracing_headers: ['localhost', 'yourdomain.com'], // Add your domain here
},
serverConfig: {
enableExceptionAutocapture: true, // Enables automatic exception capture on the server side (Nitro)
},
sourcemaps: {
enabled: true,
envId: process.env.PROJECT_ID || '',
personalApiKey: process.env.PERSONAL_API_KEY || '',
project: 'my-application',
version: '1.0.0',
},
},
})Key Points:
The
@posthog/nuxtmodule handles PostHog initialization automaticallyClient-side error tracking is enabled via
capture_exceptions: trueServer-side error tracking is enabled via
enableExceptionAutocapture: trueSource map uploads are configured for better error tracking
The
tracing_headersoption automatically addsX-POSTHOG-SESSION-IDandX-POSTHOG-DISTINCT-IDheaders to requests
Important: do not identify users on the server-side.
User identification (app/pages/index.vue)
The user is identified when the user logs in on the client-side.
const posthog = usePostHog()
const handleSubmit = async () => {
const success = await auth.login(formData.username, formData.password)
if (success) {
// Identifying the user once on login/sign up is enough.
posthog?.identify(formData.username)
// Capture login event
posthog?.capture('user_logged_in')
}
}The session and distinct ID are automatically passed to the backend via the X-POSTHOG-SESSION-ID and X-POSTHOG-DISTINCT-ID headers because we set the tracing_headers option in the PostHog configuration.
Important: do not identify users on the server-side.
Server-side API routes (server/api/auth/login.post.ts)
Server-side API routes use the useServerPostHog() utility to get a PostHog Node client and extract session and user context from request headers:
import { useServerPostHog } from '../../utils/posthog'
import { getOrCreateUser, users } from '../../utils/users'
export default defineEventHandler(async (event) => {
const body = await readBody<{ username: string; password: string }>(event)
const { username, password } = body || {}
if (!username || !password) {
throw createError({
statusCode: 400,
message: 'Username and password required',
})
}
const user = getOrCreateUser(username)
const isNewUser = !users.has(username)
const sessionId = getHeader(event, 'x-posthog-session-id')
const distinctId = getHeader(event, 'x-posthog-distinct-id')
// Capture server-side login event
const posthog = useServerPostHog()
posthog.capture({
distinctId: distinctId,
event: 'server_login',
properties: {
$session_id: sessionId,
username: username,
isNewUser: isNewUser,
source: 'api',
},
})
return {
success: true,
user,
}
})Key Points:
Uses
useServerPostHog()utility to get a shared PostHog Node client instanceExtracts
sessionIdanddistinctIdfrom request headers usinggetHeader()(auto-imported from h3)The PostHog client is reused across requests (singleton pattern)
h3 functions like
defineEventHandler,readBody,createError,getHeaderare auto-imported in server routes
Event tracking (app/pages/burrito.vue)
The burrito consideration page demonstrates both client-side and server-side event tracking:
const posthog = usePostHog()
const handleConsideration = async () => {
if (!user.value) return
try {
// Call server-side API route
const response = await $fetch('/api/burrito/consider', {
method: 'POST',
body: { username: user.value.username },
})
if (response.success && response.user) {
auth.setUser(response.user)
hasConsidered.value = true
// Client-side tracking (in addition to server-side tracking)
posthog?.capture('burrito_considered', {
total_considerations: response.user.burritoConsiderations,
username: response.user.username,
})
setTimeout(() => {
hasConsidered.value = false
}, 2000)
}
} catch (err) {
console.error('Error considering burrito:', err)
}
}The server-side route (server/api/burrito/consider.post.ts) also captures the event, demonstrating dual tracking.
Error tracking
Errors are captured automatically in multiple ways:
Automatic client-side capture - The
@posthog/nuxtmodule automatically captures Vue errors whencapture_exceptions: trueis set inposthogConfig.clientConfig.Automatic server-side capture - The module automatically captures Nitro errors when
enableExceptionAutocapture: trueis set inposthogConfig.serverConfig.Manual error capture in components (app/pages/profile.vue):
const posthog = usePostHog()
const triggerTestError = () => {
try {
throw new Error('Test error for PostHog error tracking')
} catch (err) {
posthog?.captureException(err)
}
}Server-side tracking (server/api/auth/login.post.ts)
Server-side events use the shared PostHog Node client. Note that h3 functions are auto-imported in Nuxt server routes:
import { useServerPostHog } from '../../utils/posthog'
import { getOrCreateUser, users } from '../../utils/users'
export default defineEventHandler(async (event) => {
const body = await readBody<{ username: string; password: string }>(event)
const { username, password } = body || {}
// ... validation logic ...
// Extract headers using getHeader (auto-imported from h3)
const sessionId = getHeader(event, 'x-posthog-session-id')
const distinctId = getHeader(event, 'x-posthog-distinct-id')
// Capture server-side event
const posthog = useServerPostHog()
posthog.capture({
distinctId: distinctId,
event: 'server_login',
properties: {
$session_id: sessionId,
username: username,
isNewUser: isNewUser,
source: 'api',
},
})
return { success: true, user }
})Key Points:
The PostHog Node client is shared across requests via
useServerPostHog()utilitygetHeader()is auto-imported from h3 in Nuxt server routes (no need to import from 'h3')h3 functions like
defineEventHandler,readBody,createErrorare also auto-importedThe
distinctIdandsessionIdare extracted from request headers and used to maintain context between client and serverNo need to manually shutdown the client (it's managed by the module)
Accessing PostHog in components
PostHog is accessed via the usePostHog() composable provided by @posthog/nuxt:
const posthog = usePostHog()
posthog?.capture('event_name', { property: 'value' })The composable is automatically typed and available throughout your Nuxt application.
Server-side PostHog utility (server/utils/posthog.ts)
The server utility provides a shared PostHog Node client instance:
import { PostHog } from 'posthog-node'
let client: PostHog | null = null
export function useServerPostHog(): PostHog {
if (!client) {
const config = useRuntimeConfig()
const posthogConfig = config.public.posthog
client = new PostHog(posthogConfig.publicKey, {
host: posthogConfig.host,
})
}
return client
}This ensures a single PostHog client instance is reused across all server requests, improving performance.
Differences from Nuxt 3.6
Module-based: Uses
@posthog/nuxtmodule instead of manual plugin setupAutomatic error tracking: Built-in error capture on both client and server
Source map uploads: Automatic source map uploads for better error tracking
Simplified API: Uses
usePostHog()composable instead ofuseNuxtApp().$posthogShared server client: Reuses PostHog Node client across requests instead of creating per-request
Automatic imports: In Nuxt 4 server routes, h3 functions (
defineEventHandler,readBody,createError,getHeader, etc.) are auto-imported - no need to import them explicitly
Learn More
.env.example
NUXT_PUBLIC_POSTHOG_PROJECT_TOKEN=
NUXT_PUBLIC_POSTHOG_HOST=
PROJECT_ID=
PERSONAL_API_KEY=app/app.vue
<template>
<div style="min-height: 100vh; display: flex; flex-direction: column; background: #f5f5f5; width: 100%;">
<AppHeader />
<main style="flex: 1;">
<NuxtPage />
</main>
</div>
</template>
app/components/AppHeader.vue
<template>
<header class="header">
<div class="header-container">
<nav>
<NuxtLink to="/">Home</NuxtLink>
<template v-if="user">
<NuxtLink to="/burrito">Burrito Consideration</NuxtLink>
<NuxtLink to="/profile">Profile</NuxtLink>
</template>
</nav>
<div class="user-section">
<span v-if="user">Welcome, {{ user.username }}!</span>
<span v-else>Not logged in</span>
<button v-if="user" @click="handleLogout" class="btn-logout">Logout</button>
</div>
</div>
</header>
</template>
<script setup lang="ts">
const posthog = usePostHog()
const auth = useAuth()
const user = computed(() => auth.user.value)
const handleLogout = async () => {
auth.logout()
posthog?.capture('user_logged_out')
posthog?.reset()
await navigateTo('/')
}
</script>
app/composables/useAuth.ts
interface User {
username: string
burritoConsiderations: number
}
const users: Map<string, User> = new Map()
export function useAuth() {
const user = useState<User | null>('auth-user', () => {
if (process.client) {
const storedUsername = localStorage.getItem('currentUser')
if (storedUsername) {
const existingUser = users.get(storedUsername)
if (existingUser) {
return existingUser
}
}
}
return null
})
const login = async (username: string, password: string): Promise<boolean> => {
try {
const response = await $fetch<{ success: boolean; user: User }>('/api/auth/login', {
method: 'POST',
body: { username, password },
})
if (response.success) {
let localUser = users.get(username)
if (!localUser) {
localUser = response.user
users.set(username, localUser)
}
user.value = localUser
if (process.client) {
localStorage.setItem('currentUser', username)
}
return true
}
return false
} catch (error) {
console.error('Login error:', error)
return false
}
}
const logout = () => {
user.value = null
if (process.client) {
localStorage.removeItem('currentUser')
}
}
const incrementBurritoConsiderations = () => {
if (user.value) {
user.value.burritoConsiderations++
users.set(user.value.username, user.value)
// Trigger reactivity
user.value = { ...user.value }
}
}
const setUser = (newUser: User) => {
user.value = newUser
users.set(newUser.username, newUser)
}
return {
user,
login,
logout,
incrementBurritoConsiderations,
setUser,
}
}
app/middleware/auth.ts
export default defineNuxtRouteMiddleware((to, from) => {
const auth = useAuth()
const user = auth.user.value
// If user is not logged in, redirect to home/login page
if (!user) {
return navigateTo('/')
}
})
app/pages/burrito.vue
<template>
<div class="container">
<h1>Burrito consideration zone</h1>
<p>Take a moment to truly consider the potential of burritos.</p>
<div style="text-align: center">
<button @click="handleConsideration" class="btn-burrito">
I have considered the burrito potential
</button>
<p v-if="hasConsidered" class="success">
Thank you for your consideration! Count: {{ user?.burritoConsiderations }}
</p>
</div>
<div class="stats">
<h3>Consideration stats</h3>
<p>Total considerations: {{ user?.burritoConsiderations }}</p>
</div>
</div>
</template>
<script setup lang="ts">
definePageMeta({
middleware: 'auth'
})
const auth = useAuth()
const user = computed(() => auth.user.value)
const posthog = usePostHog()
const hasConsidered = ref(false)
const handleConsideration = async () => {
if (!user.value) return
try {
const response = await $fetch('/api/burrito/consider', {
method: 'POST',
body: { username: user.value.username },
})
if (response.success && response.user) {
auth.setUser(response.user)
hasConsidered.value = true
// Client-side tracking (in addition to server-side tracking)
posthog?.capture('burrito_considered', {
total_considerations: response.user.burritoConsiderations,
username: response.user.username,
})
setTimeout(() => {
hasConsidered.value = false
}, 2000)
}
} catch (err) {
console.error('Error considering burrito:', err)
}
}
</script>
app/pages/index.vue
<template>
<div class="container">
<h1 v-if="user">Welcome back, {{ user.username }}!</h1>
<h1 v-else>Welcome to Burrito Consideration App</h1>
<div v-if="user">
<p>You are logged in. Feel free to explore:</p>
<ul>
<li>Consider the potential of burritos</li>
<li>View your profile and statistics</li>
</ul>
</div>
<div v-else>
<p>Please sign in to begin your burrito journey</p>
<form @submit.prevent="handleSubmit" class="form" novalidate>
<div class="form-group">
<label for="username">Username:</label>
<input
id="username"
v-model="formData.username"
type="text"
placeholder="Enter any username"
:class="{ 'error-input': errors.username }"
@blur="validateField('username')"
@input="clearError('username')"
/>
<p v-if="errors.username" class="field-error">{{ errors.username }}</p>
</div>
<div class="form-group">
<label for="password">Password:</label>
<input
id="password"
v-model="formData.password"
type="password"
placeholder="Enter any password"
:class="{ 'error-input': errors.password }"
@blur="validateField('password')"
@input="clearError('password')"
/>
<p v-if="errors.password" class="field-error">{{ errors.password }}</p>
</div>
<p v-if="error" class="error">{{ error }}</p>
<button type="submit" class="btn-primary" :disabled="isSubmitting">
{{ isSubmitting ? 'Signing in...' : 'Sign In' }}
</button>
</form>
<p class="note">
Note: This is a demo app. Use any username and password to sign in.
</p>
</div>
</div>
</template>
<script setup lang="ts">
import { loginSchema, validateForm, type LoginFormData } from '../utils/formValidation'
const auth = useAuth()
const user = computed(() => auth.user.value)
const posthog = usePostHog()
const formData = reactive<LoginFormData>({
username: '',
password: '',
})
const errors = reactive<Partial<Record<keyof LoginFormData, string>>>({})
const error = ref('')
const isSubmitting = ref(false)
const validateField = (field: keyof LoginFormData) => {
const fieldSchema = loginSchema.shape[field]
if (!fieldSchema) return
const result = fieldSchema.safeParse(formData[field])
if (!result.success) {
errors[field] = result.error.errors[0]?.message || 'Invalid value'
} else {
delete errors[field]
}
}
const clearError = (field: keyof LoginFormData) => {
delete errors[field]
}
const handleSubmit = async () => {
// Clear previous errors
error.value = ''
Object.keys(errors).forEach((key) => {
delete errors[key as keyof LoginFormData]
})
// Validate entire form
const validation = validateForm(loginSchema, formData)
if (!validation.success) {
Object.assign(errors, validation.errors)
return
}
isSubmitting.value = true
try {
const success = await auth.login(formData.username, formData.password)
if (success) {
// Identifying the user once on login/sign up is enough.
posthog?.identify(formData.username)
// Capture login event
posthog?.capture('user_logged_in')
formData.username = ''
formData.password = ''
await navigateTo('/')
} else {
error.value = 'Login failed. Please check your credentials and try again.'
}
} catch (err) {
console.error('Login failed:', err)
error.value = 'An error occurred during login. Please try again.'
} finally {
isSubmitting.value = false
}
}
</script>
app/pages/profile.vue
<template>
<div class="container">
<h1>User Profile</h1>
<div class="stats">
<h2>Your Information</h2>
<p><strong>Username:</strong> {{ user?.username }}</p>
<p><strong>Burrito Considerations:</strong> {{ user?.burritoConsiderations }}</p>
</div>
<div style="margin-top: 2rem">
<button @click="triggerTestError" class="btn-primary" style="background-color: #dc3545">
Trigger Test Error (for PostHog)
</button>
</div>
<div style="margin-top: 2rem">
<h3>Your Burrito Journey</h3>
<p v-if="user?.burritoConsiderations === 0">
You haven't considered any burritos yet. Visit the Burrito Consideration page to start!
</p>
<p v-else-if="user?.burritoConsiderations === 1">
You've considered the burrito potential once. Keep going!
</p>
<p v-else-if="user && user.burritoConsiderations < 5">
You're getting the hang of burrito consideration!
</p>
<p v-else-if="user && user.burritoConsiderations < 10">
You're becoming a burrito consideration expert!
</p>
<p v-else>You are a true burrito consideration master! 🌯</p>
</div>
</div>
</template>
<script setup lang="ts">
definePageMeta({
middleware: 'auth'
})
const auth = useAuth()
const user = computed(() => auth.user.value)
const posthog = usePostHog()
const triggerTestError = () => {
try {
throw new Error('Test error for PostHog error tracking')
} catch (err) {
console.error('Captured error:', err)
posthog?.captureException(err)
}
}
</script>
app/utils/formValidation.ts
import { z } from 'zod'
export const loginSchema = z.object({
username: z
.string()
.min(1, 'Username is required')
.min(3, 'Username must be at least 3 characters')
.max(50, 'Username must be less than 50 characters'),
password: z
.string()
.min(1, 'Password is required')
.min(3, 'Password must be at least 3 characters'),
})
export type LoginFormData = z.infer<typeof loginSchema>
export function validateForm<T>(schema: z.ZodSchema<T>, data: unknown): {
success: boolean
data?: T
errors?: Record<string, string>
} {
const result = schema.safeParse(data)
if (result.success) {
return { success: true, data: result.data }
}
const errors: Record<string, string> = {}
result.error.errors.forEach((error) => {
const path = error.path.join('.')
errors[path] = error.message
})
return { success: false, errors }
}
nuxt.config.ts
import { fileURLToPath } from 'node:url'
import { resolve, dirname } from 'node:path'
const __filename = fileURLToPath(import.meta.url)
const __dirname = dirname(__filename)
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
compatibilityDate: '2025-07-15',
devtools: { enabled: true },
css: [resolve(__dirname, 'assets/css/main.css')],
modules: ['@posthog/nuxt'],
runtimeConfig: {
public: {
posthog: {
publicKey: process.env.NUXT_PUBLIC_POSTHOG_PROJECT_TOKEN || '',
host: process.env.NUXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com',
},
},
},
posthogConfig: {
publicKey: process.env.NUXT_PUBLIC_POSTHOG_PROJECT_TOKEN || '', // Find it in project settings https://app.posthog.com/settings/project
host: process.env.NUXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com', // Optional: defaults to https://us.i.posthog.com. Use https://eu.i.posthog.com for EU region
clientConfig: {
capture_exceptions: true, // Enables automatic exception capture on the client side (Vue)
tracing_headers: [ 'localhost', 'yourdomain.com' ], // Add your domain here
},
serverConfig: {
enableExceptionAutocapture: true, // Enables automatic exception capture on the server side (Nitro)
},
sourcemaps: {
enabled: true,
envId: process.env.PROJECT_ID || '', // Your project ID from PostHog settings https://app.posthog.com/settings/environment#variables
personalApiKey: process.env.PERSONAL_API_KEY || '', // Your personal API key from PostHog settings https://app.posthog.com/settings/user-api-keys (requires organization:read and error_tracking:write scopes)
project: 'my-application', // Optional: defaults to git repository name
version: '1.0.0', // Optional: defaults to current git commit
},
},
})
public/robots.txt
User-Agent: *
Disallow:
server/api/auth/login.post.ts
import { useServerPostHog } from '../../utils/posthog'
import { getOrCreateUser, users } from '../../utils/users'
export default defineEventHandler(async (event) => {
const body = await readBody<{ username: string; password: string }>(event)
const { username, password } = body || {}
if (!username || !password) {
throw createError({
statusCode: 400,
message: 'Username and password required',
})
}
const user = getOrCreateUser(username)
const isNewUser = !users.has(username)
const sessionId = getHeader(event, 'x-posthog-session-id')
const distinctId = getHeader(event, 'x-posthog-distinct-id')
// Capture server-side login event
const posthog = useServerPostHog()
posthog.capture({
distinctId: distinctId,
event: 'server_login',
properties: {
$session_id: sessionId,
username: username,
isNewUser: isNewUser,
source: 'api',
},
})
// This handler is short-lived; flush so the enqueued event sends before it returns
await posthog.flush()
return {
success: true,
user,
}
})
server/api/burrito/consider.post.ts
import { useServerPostHog } from '../../utils/posthog'
import { users, incrementBurritoConsiderations } from '../../utils/users'
import { defineEventHandler, readBody, createError, getHeader } from 'h3'
export default defineEventHandler(async (event) => {
const body = await readBody<{ username: string }>(event)
const username = body?.username
if (!username) {
throw createError({
statusCode: 400,
message: 'Username required',
})
}
if (!users.has(username)) {
throw createError({
statusCode: 404,
message: 'User not found',
})
}
// Increment burrito considerations (fake, in-memory)
const user = incrementBurritoConsiderations(username)
const sessionId = getHeader(event, 'x-posthog-session-id')
const distinctId = getHeader(event, 'x-posthog-distinct-id')
// Capture server-side burrito consideration event
const posthog = useServerPostHog()
posthog.capture({
distinctId: distinctId,
event: 'burrito_considered',
properties: {
$session_id: sessionId,
username: username,
total_considerations: user.burritoConsiderations,
source: 'api',
},
})
// This handler is short-lived; flush so the enqueued event sends before it returns
await posthog.flush()
return {
success: true,
user: { ...user },
}
})
server/utils/posthog.ts
import { PostHog } from 'posthog-node'
let client: PostHog | null = null
export function useServerPostHog(): PostHog {
if (!client) {
const config = useRuntimeConfig()
// The @posthog/nuxt module exposes config at runtimeConfig.public.posthog
const posthogConfig = config.public.posthog
client = new PostHog(posthogConfig.publicKey, {
host: posthogConfig.host,
flushAt: 1,
flushInterval: 0,
})
}
return client
}
server/utils/users.ts
// Shared in-memory storage for users (fake, no database)
export const users = new Map<string, { username: string; burritoConsiderations: number }>()
export function getOrCreateUser(username: string): { username: string; burritoConsiderations: number } {
let user = users.get(username)
if (!user) {
user = { username, burritoConsiderations: 0 }
users.set(username, user)
}
return user
}
export function incrementBurritoConsiderations(username: string): { username: string; burritoConsiderations: number } {
const user = users.get(username)
if (!user) {
throw new Error('User not found')
}
user.burritoConsiderations++
users.set(username, user)
return { ...user }
}
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs an MCP server, Needs Python, Needs Node.js
Security
What our scanner noticed· Low risk
- Instructions that use the network
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- PostHog
- Publisher
- PostHog (Official)
- Source
- PostHog/skills · skills/omnibus/instrument-product-analytics · commit a5d30e7
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by PostHog.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download instrument-product-analytics.zip