AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured, multi-step procedure for integrating the PostHog SDK into a wide range of web, mobile, and backend frameworks. It handles the detection of the project environment, installation of the appropriate SDK, initialization, user identification, and secure configuration of environment variables. The skill emphasizes following framework-specific patterns and maintaining an analytics contract, ensuring that PostHog is implemented consistently without disrupting existing application logic.
What it does
- Detects the project's framework, language, and package manager.
- Installs the correct PostHog SDK for the identified platform.
- Configures PostHog initialization and provider setup based on framework-specific references.
- Implements user identification logic for login and signup events.
- Manages environment variables for project tokens and host URLs securely.
- Verifies the integration and performs minimal cleanup.
When to use it
- When setting up PostHog in a project for the first time.
- When reviewing pull requests that require PostHog initialization.
- When adding analytics to a new application across supported frameworks.
- When migrating or updating PostHog configurations in an existing codebase.
Advantages
- Ensures consistent implementation across diverse technology stacks.
- Prevents hardcoding of sensitive project tokens and host URLs.
- Follows established framework-specific best practices and patterns.
- Minimizes the risk of breaking application boot or build processes.
- Automates the repetitive aspects of SDK setup and environment configuration.
Usage examples
- “Set up PostHog in my Next.js project.”
- The agent will detect the Next.js environment, install the PostHog SDK, configure the necessary provider, and set up environment variables in .env.local.
- “Integrate PostHog into this Android app.”
- The agent will identify the Android/Kotlin structure, initialize PostHog in the Application class, and guide the setup of local.properties for configuration.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/posthog/instrument-integration/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip instrument-integration.zip -d .agents/skills
Documentation by PostHog
Add PostHog SDK integration
Use this skill to add the PostHog SDK to an application. Use it when setting up PostHog for the first time, or reviewing PRs that need PostHog initialization. Covers SDK installation, provider setup, and basic configuration. Supports any framework or language.
Supported frameworks and languages: Next.js, React, React Router, Vue, Nuxt, TanStack Start, SvelteKit, Astro, Angular, Django, Flask, FastAPI, Laravel, PHP, Ruby on Rails, Go, Elixir, Android, iOS, Swift, Flutter, React Native, Expo, Node.js, and vanilla JavaScript.
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, do not modify its code. Inform the user and skip to verification.
STEP 2: Research integration. 2.1. Find the reference file below that matches the detected framework — it is the source of truth for SDK initialization, provider setup, and configuration 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.
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.
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).
Set up the PostHog provider/wrapper component if the framework requires one.
STEP 5: Identify users.
Add PostHog
identify()calls on the client side during login and signup events.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.
STEP 6: 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 (e.g.
.env.localfor Next.js,.envfor others) using the framework's naming convention.Reference these environment variables in code instead of hardcoding them.
STEP 7: 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-react-vite.md- react-vite 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-javascript-node.md- javascript-node example project codereferences/EXAMPLE-javascript-web.md- javascript-web 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.md- Reactreferences/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/js.md- JavaScript webreferences/posthog-js.md- PostHog JavaScript web SDKreferences/node.md- Node.jsreferences/posthog-node.md- PostHog Node.js SDKreferences/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 example: Your implementation should follow the example project's patterns as closely as possible.
Analytics contract: Treat event names, property names, and feature flag keys as part of an analytics contract. Reuse existing names and patterns found in the project. When introducing new ones, make them clear, descriptive, and consistent with existing conventions.
Files
- ATTRIBUTION.mdAdded by AutoGineer952 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md8.8 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-javascript-node.md9.0 KiB
- references/EXAMPLE-javascript-web.md11.8 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-react-vite.md12.4 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/js.md16.1 KiB
- references/laravel.md13.1 KiB
- references/next-js.md18.3 KiB
- references/node.md45.6 KiB
- references/nuxt-js-3-6.md11.4 KiB
- references/nuxt-js.md15.1 KiB
- references/php.md23.7 KiB
- references/posthog-js.md51.6 KiB
- references/posthog-node.md33.9 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/react.md21.9 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-javascript-web.md
PostHog javascript-web Example Project
Repository: https://github.com/PostHog/context-mill Path: example-apps/javascript-web
README.md
PostHog JavaScript Example - Browser Todo App
A simple browser-based todo application built with vanilla JavaScript and Vite, demonstrating PostHog integration for non-framework JavaScript projects.
Purpose
This example serves as:
Verification that the context-mill wizard works for plain JavaScript projects
Reference implementation of PostHog best practices for vanilla JS browser apps
Working example you can run and modify
Features Demonstrated
PostHog initialization -
posthog.init()withapi_hostconfigurationAutocapture - Automatic tracking of clicks, form submissions, and pageviews (enabled by default)
Custom event tracking - Manual
posthog.capture()calls with event propertiesUser identification -
posthog.identify()on login andposthog.reset()on logoutError tracking -
posthog.captureException()for unhandled errors and promise rejections
Quick Start
1. Install Dependencies
npm install2. Configure PostHog
# Copy environment template
cp .env.example .env
# Edit .env and add your PostHog project token
# VITE_POSTHOG_PROJECT_TOKEN=phc_your_project_token_here
# VITE_POSTHOG_HOST=https://us.i.posthog.com3. Run the App
npm run devOpen http://localhost:3000 in your browser.
What Gets Tracked
The app tracks these custom events in PostHog (in addition to autocaptured clicks and pageviews):
| Event | Properties | Purpose |
|---|---|---|
todo_added | todo_id, text_length, total_todos | When user adds a new todo |
todo_completed | todo_id, time_to_complete_hours | When user completes a todo |
todo_deleted | todo_id, was_completed | When user deletes a todo |
user_logged_in | (none) | When user logs in |
user_logged_out | (none) | When user logs out |
Code Structure
example-apps/javascript-web/
├── index.html # Entry HTML page
├── package.json # Dependencies (posthog-js, vite)
├── vite.config.js # Vite configuration
├── .env.example # Environment variable template
├── .gitignore # Git ignore rules
├── README.md # This file
└── src/
├── posthog.js # PostHog initialization (import this first)
├── main.js # Todo app logic with event tracking
└── style.css # App stylesKey Implementation Patterns
1. Initialization (posthog.js)
import posthog from 'posthog-js'
posthog.init('your-project-token', {
api_host: 'https://us.i.posthog.com',
})Initialize PostHog once, early in your app. All other modules import the same instance.
2. Event Tracking
// Track events with properties — never send PII or user-generated content
posthog.capture('event_name', {
item_count: 5, // Metadata is OK
action_type: 'create', // Categories are OK
})3. User Identification
// On login — links events to a known user
posthog.identify('user_123')
// On logout — resets to a new anonymous distinct_id
posthog.reset()4. Error Tracking
// Global error handlers
window.addEventListener('error', (event) => {
posthog.captureException(event.error)
})
window.addEventListener('unhandledrejection', (event) => {
posthog.captureException(event.reason)
})Running Without PostHog
The app works fine without PostHog configured. You'll see a console warning but the app continues to function normally.
Next Steps
Modify the app to experiment with PostHog tracking
Explore feature flags:
posthog.isFeatureEnabled('flag-key')Check your PostHog dashboard to see tracked events and autocaptured data
Try session recording (enable in PostHog project settings)
Learn More
.env.example
# PostHog Configuration
VITE_POSTHOG_PROJECT_TOKEN=phc_your_project_token_here
VITE_POSTHOG_HOST=https://us.i.posthog.com
# Optional: Enable debug mode to see PostHog requests in console
# VITE_POSTHOG_DEBUG=true
index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Todo App - PostHog JavaScript Example</title>
<link rel="stylesheet" href="/src/style.css" />
</head>
<body>
<div id="app">
<header>
<h1>Todo App</h1>
<div id="auth-section">
<div id="logged-out">
<input type="text" id="username-input" placeholder="Enter username" />
<button id="login-btn">Log In</button>
</div>
<div id="logged-in" hidden>
<span id="username-display"></span>
<button id="logout-btn">Log Out</button>
</div>
</div>
</header>
<main>
<form id="todo-form">
<input type="text" id="todo-input" placeholder="What needs to be done?" required />
<button type="submit">Add</button>
</form>
<ul id="todo-list"></ul>
<div id="stats">
<span id="total-count">0 items</span>
<span id="completed-count">0 completed</span>
</div>
</main>
</div>
<script type="module" src="/src/main.js"></script>
</body>
</html>
src/main.js
/**
* Simple Todo App with PostHog Analytics
*
* A minimal vanilla JavaScript application demonstrating PostHog integration
* for non-framework browser JavaScript projects.
*/
import posthog from './posthog.js';
// --- State ---
let todos = JSON.parse(localStorage.getItem('todos') || '[]');
let currentUser = localStorage.getItem('currentUser') || null;
// --- DOM Elements ---
const todoForm = document.getElementById('todo-form');
const todoInput = document.getElementById('todo-input');
const todoList = document.getElementById('todo-list');
const totalCount = document.getElementById('total-count');
const completedCount = document.getElementById('completed-count');
const loginBtn = document.getElementById('login-btn');
const logoutBtn = document.getElementById('logout-btn');
const usernameInput = document.getElementById('username-input');
const usernameDisplay = document.getElementById('username-display');
const loggedOutSection = document.getElementById('logged-out');
const loggedInSection = document.getElementById('logged-in');
// --- Auth ---
function login() {
const username = usernameInput.value.trim();
if (!username) return;
currentUser = username;
localStorage.setItem('currentUser', username);
// Identify user in PostHog — links all future events to this user
// Pass person properties as second arg (this is where name/email belong, NOT in capture())
posthog.identify(username, { name: username });
posthog.capture('user_logged_in');
updateAuthUI();
usernameInput.value = '';
}
function logout() {
currentUser = null;
localStorage.removeItem('currentUser');
// Reset PostHog — unlinks future events from the current user
// and generates a new anonymous distinct_id
posthog.reset();
posthog.capture('user_logged_out');
updateAuthUI();
}
function updateAuthUI() {
if (currentUser) {
loggedOutSection.hidden = true;
loggedInSection.hidden = false;
usernameDisplay.textContent = currentUser;
} else {
loggedOutSection.hidden = false;
loggedInSection.hidden = true;
}
}
// --- Todos ---
function addTodo(text) {
const todo = {
id: Date.now(),
text,
completed: false,
createdAt: new Date().toISOString(),
};
todos.push(todo);
saveTodos();
renderTodos();
// Track the event — only metadata, never PII or user-generated content
posthog.capture('todo_added', {
todo_id: todo.id,
text_length: text.length,
total_todos: todos.length,
});
}
function toggleTodo(id) {
const todo = todos.find((t) => t.id === id);
if (!todo) return;
todo.completed = !todo.completed;
saveTodos();
renderTodos();
if (todo.completed) {
const timeToComplete =
(Date.now() - new Date(todo.createdAt).getTime()) / 3600000;
posthog.capture('todo_completed', {
todo_id: todo.id,
time_to_complete_hours: Math.round(timeToComplete * 100) / 100,
});
}
}
function deleteTodo(id) {
const todo = todos.find((t) => t.id === id);
if (!todo) return;
todos = todos.filter((t) => t.id !== id);
saveTodos();
renderTodos();
posthog.capture('todo_deleted', {
todo_id: todo.id,
was_completed: todo.completed,
});
}
function saveTodos() {
localStorage.setItem('todos', JSON.stringify(todos));
}
// --- Rendering ---
function renderTodos() {
todoList.innerHTML = '';
for (const todo of todos) {
const li = document.createElement('li');
li.className = `todo-item${todo.completed ? ' completed' : ''}`;
const checkbox = document.createElement('input');
checkbox.type = 'checkbox';
checkbox.checked = todo.completed;
checkbox.addEventListener('change', () => toggleTodo(todo.id));
const text = document.createElement('span');
text.className = 'todo-text';
text.textContent = todo.text;
const deleteBtn = document.createElement('button');
deleteBtn.className = 'delete-btn';
deleteBtn.textContent = 'Delete';
deleteBtn.addEventListener('click', () => deleteTodo(todo.id));
li.append(checkbox, text, deleteBtn);
todoList.appendChild(li);
}
// Update stats
const completed = todos.filter((t) => t.completed).length;
totalCount.textContent = `${todos.length} item${todos.length !== 1 ? 's' : ''}`;
completedCount.textContent = `${completed} completed`;
}
// --- Error Tracking ---
// Capture unhandled errors with PostHog
window.addEventListener('error', (event) => {
posthog.captureException(event.error);
});
window.addEventListener('unhandledrejection', (event) => {
posthog.captureException(event.reason);
});
// --- Event Listeners ---
todoForm.addEventListener('submit', (e) => {
e.preventDefault();
const text = todoInput.value.trim();
if (text) {
addTodo(text);
todoInput.value = '';
}
});
loginBtn.addEventListener('click', login);
usernameInput.addEventListener('keydown', (e) => {
if (e.key === 'Enter') login();
});
logoutBtn.addEventListener('click', logout);
// --- Init ---
// Restore auth state and re-identify if already logged in
if (currentUser) {
posthog.identify(currentUser, { name: currentUser });
}
updateAuthUI();
renderTodos();
src/posthog.js
/**
* PostHog initialization for vanilla JavaScript.
*
* Initializes posthog-js once and exports the instance for use across the app.
* This file should be imported before any other modules that call PostHog methods.
*/
import posthog from 'posthog-js';
const projectToken = import.meta.env.VITE_POSTHOG_PROJECT_TOKEN;
const apiHost = import.meta.env.VITE_POSTHOG_HOST || 'https://us.i.posthog.com';
if (!projectToken) {
console.warn(
'PostHog not configured (VITE_POSTHOG_PROJECT_TOKEN not set).',
'App will work but analytics will not be tracked.',
);
} else {
posthog.init(projectToken, {
api_host: apiHost,
// Autocapture is ON by default — tracks clicks, form submissions, pageviews
// capture_pageview: true (default) — captures $pageview on init
// For SPAs with History API routing, use: capture_pageview: 'history_change'
});
}
export default posthog;
vite.config.js
import { defineConfig } from 'vite';
export default defineConfig({
server: {
port: 3000,
},
});
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-integration · 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 or PostHog.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download instrument-integration.zip