Omnibus Instrument Integration
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 procedure for integrating the PostHog SDK into a wide variety of software projects. It guides the agent through detecting the project's framework, installing the appropriate SDK, initializing the client, and configuring environment variables. By leveraging a library of framework-specific reference files, the skill ensures that PostHog is implemented according to best practices for each supported platform, including web, mobile, and backend environments.
What it does
- Detects the project's framework and package manager automatically.
- Installs the correct PostHog SDK for the identified platform.
- Initializes the PostHog client using framework-specific patterns.
- Configures environment variables for API keys and host settings.
- Implements user identification logic for login and signup events.
- Verifies the integration and performs necessary 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 migrating or adding analytics to an existing codebase.
- When you need to ensure PostHog is configured consistently across different frameworks.
Advantages
- Supports a broad range of frameworks and languages.
- Ensures secure configuration by enforcing the use of environment variables.
- Maintains consistency with existing codebase patterns.
- Reduces manual effort by automating SDK installation and boilerplate setup.
Usage examples
- “Add PostHog to my new Next.js project.”
- The agent will detect the Next.js framework, install the PostHog SDK, and provide the necessary initialization code in the appropriate file, such as instrumentation-client.ts.
- “Help me set up PostHog in our Android app.”
- The agent will identify the Android environment, guide the setup in the Application class, and configure the PostHog instance with the required API keys.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/posthog/omnibus-instrument-integration/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip omnibus-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: Next.js, React, React Router, Vue, Nuxt, TanStack Start, SvelteKit, Astro, Angular, Django, Flask, FastAPI, Laravel, Ruby on Rails, Android, Swift, 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, requirements.txt, Gemfile, composer.json, go.mod, etc.) to determine the framework and language.
Look for lockfiles (pnpm-lock.yaml, package-lock.json, yarn.lock, bun.lockb) 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.
Always install packages as a background task. Don't await completion; proceed with other work immediately after starting the installation.
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.
Store the PostHog API key and host in environment variables (e.g.
.envor framework-specific env files).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.
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-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.js - docsreferences/react.md- React - docsreferences/react-router-v6.md- React router v6 - docsreferences/react-router-v7-framework-mode.md- React router v7 framework mode (remix v3) - docsreferences/react-router-v7-data-mode.md- React router v7 data mode - docsreferences/react-router-v7-declarative-mode.md- React router v7 declarative mode - docsreferences/nuxt-js-3-6.md- Nuxt.js (v3.0 to v3.6) - docsreferences/nuxt-js.md- Nuxt.js - docsreferences/vue-js.md- Vue.js - docsreferences/tanstack-start.md- Tanstack start - docsreferences/svelte.md- Svelte - docsreferences/astro.md- Astro - docsreferences/angular.md- Angular - docsreferences/js.md- JavaScript web - docsreferences/posthog-js.md- PostHog JavaScript web SDKreferences/node.md- Node.js - docsreferences/posthog-node.md- PostHog Node.js SDKreferences/django.md- Django - docsreferences/flask.md- Flask - docsreferences/python.md- Python - docsreferences/posthog-python.md- PostHog python SDKreferences/laravel.md- Laravel - docsreferences/ruby-on-rails.md- Ruby on rails - docsreferences/ruby.md- Ruby - docsreferences/android.md- Android - docsreferences/ios.md- Ios - docsreferences/react-native.md- React native - docsreferences/identify-users.md- Identify users - docs
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 AutoGineer998 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md7.6 KiB
- references/EXAMPLE-android.md49.7 KiB
- references/EXAMPLE-angular.md23.4 KiB
- references/EXAMPLE-astro-hybrid.md26.8 KiB
- references/EXAMPLE-astro-ssr.md26.7 KiB
- references/EXAMPLE-astro-static.md19.4 KiB
- references/EXAMPLE-astro-view-transitions.md23.1 KiB
- references/EXAMPLE-django.md30.0 KiB
- references/EXAMPLE-expo.md35.5 KiB
- references/EXAMPLE-fastapi.md40.9 KiB
- references/EXAMPLE-flask.md32.0 KiB
- references/EXAMPLE-javascript-node.md9.0 KiB
- references/EXAMPLE-javascript-web.md11.7 KiB
- references/EXAMPLE-laravel.md59.5 KiB
- references/EXAMPLE-next-app-router.md17.3 KiB
- references/EXAMPLE-next-pages-router.md18.9 KiB
- references/EXAMPLE-nuxt-3.6.md22.1 KiB
- references/EXAMPLE-nuxt-4.md28.7 KiB
- references/EXAMPLE-python.md11.6 KiB
- references/EXAMPLE-react-native.md46.4 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.2 KiB
- references/EXAMPLE-react-tanstack-router-code-based.md19.2 KiB
- references/EXAMPLE-react-tanstack-router-file-based.md18.0 KiB
- references/EXAMPLE-react-vite.md12.4 KiB
- references/EXAMPLE-ruby-on-rails.md37.6 KiB
- references/EXAMPLE-ruby.md10.3 KiB
- references/EXAMPLE-sveltekit.md18.4 KiB
- references/EXAMPLE-swift.md18.6 KiB
- references/EXAMPLE-tanstack-start.md28.4 KiB
- references/EXAMPLE-vue-3.md17.9 KiB
- references/android.md21.7 KiB
- references/angular.md12.5 KiB
- references/astro.md8.3 KiB
- references/django.md6.7 KiB
- references/flask.md2.9 KiB
- references/identify-users.md8.1 KiB
- references/ios.md5.4 KiB
- references/js.md12.3 KiB
- references/laravel.md2.1 KiB
- references/next-js.md12.5 KiB
- references/node.md28.8 KiB
- references/nuxt-js-3-6.md6.6 KiB
- references/nuxt-js.md7.2 KiB
- references/posthog-js.md42.3 KiB
- references/posthog-node.md23.4 KiB
- references/posthog-python.md31.3 KiB
- references/python.md31.1 KiB
- references/react-native.md43.8 KiB
- references/react-router-v6.md11.6 KiB
- references/react-router-v7-data-mode.md11.4 KiB
- references/react-router-v7-declarative-mode.md11.6 KiB
- references/react-router-v7-framework-mode.md14.9 KiB
- references/react.md18.5 KiB
- references/ruby-on-rails.md10.6 KiB
- references/ruby.md18.9 KiB
- references/svelte.md7.2 KiB
- references/tanstack-start.md5.1 KiB
- references/vue-js.md9.1 KiB
references/EXAMPLE-react-vite.md
PostHog react-vite Example Project
Repository: https://github.com/PostHog/context-mill Path: basics/react-vite
README.md
PostHog React + Vite example
A minimal React application built with Vite, demonstrating PostHog integration with product analytics, session replay, feature flags, and error tracking.
This example uses no client-side router, making it the simplest possible React + PostHog setup.
Features
Product Analytics: Track user events and behaviors
Session Replay: Record and replay user sessions
Feature Flags: Toggle features with
useFeatureFlagEnabled()Error Tracking: Automatic error capture with
PostHogErrorBoundaryUser Authentication: Demo login system with PostHog user identification
Getting Started
1. Install Dependencies
npm install
# or
pnpm install2. Configure Environment Variables
Create a .env file in the root directory:
VITE_PUBLIC_POSTHOG_PROJECT_TOKEN=your_posthog_project_token
VITE_PUBLIC_POSTHOG_HOST=https://us.i.posthog.comGet your PostHog project token from your PostHog project settings.
3. Run the Development Server
npm run dev
# or
pnpm devOpen http://localhost:5173 with your browser to see the app.
Project Structure
src/
├── components/
│ └── Header.jsx # Navigation header with auth state
├── contexts/
│ └── AuthContext.jsx # Authentication context
├── pages/
│ ├── Home.jsx # Home/Login page with event tracking
│ ├── Burrito.jsx # Demo page with feature flags
│ └── Profile.jsx # User profile page
├── main.jsx # Entry point with PostHog initialization
├── App.jsx # App component with page routing
└── globals.css # Global stylesKey Integration Points
Initialization (main.jsx)
import posthog from 'posthog-js'
import { PostHogErrorBoundary, PostHogProvider } from '@posthog/react'
posthog.init(import.meta.env.VITE_PUBLIC_POSTHOG_PROJECT_TOKEN, {
api_host: import.meta.env.VITE_PUBLIC_POSTHOG_HOST,
defaults: '2026-01-30',
})
<PostHogProvider client={posthog}>
<PostHogErrorBoundary>
<App />
</PostHogErrorBoundary>
</PostHogProvider>User identification (Home.jsx)
posthog.identify(username, { name: username })
posthog.capture('user_logged_in')Feature flags (Burrito.jsx)
import { useFeatureFlagEnabled } from '@posthog/react'
const showSpecialBurrito = useFeatureFlagEnabled('special-burrito')Pageview tracking (Header.jsx)
Without a router, manually capture pageviews on navigation:
posthog.capture('$pageview', { $current_url: `/${target}` })Learn More
.env.example
VITE_PUBLIC_POSTHOG_PROJECT_TOKEN=
VITE_PUBLIC_POSTHOG_HOST=
PROJECT_ID=
index.html
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>react-vite</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.jsx"></script>
</body>
</html>
src/App.jsx
import { AuthProvider, useAuth } from './contexts/AuthContext'
import Home from './pages/Home'
import Burrito from './pages/Burrito'
import Profile from './pages/Profile'
import Header from './components/Header'
function AppContent() {
const { user } = useAuth()
if (!user) {
return <Home />
}
return <MainApp />
}
function MainApp() {
const { page } = useAuth()
return (
<>
{page === 'home' && <Home />}
{page === 'burrito' && <Burrito />}
{page === 'profile' && <Profile />}
</>
)
}
export default function App() {
return (
<AuthProvider>
<Header />
<main>
<AppContent />
</main>
</AuthProvider>
)
}
src/components/Header.jsx
import { useAuth } from '../contexts/AuthContext'
import { usePostHog } from '@posthog/react'
export default function Header() {
const { user, logout, page, setPage } = useAuth()
const posthog = usePostHog()
const handleLogout = () => {
if (user) {
posthog.capture('user_logged_out', {
username: user.username,
})
}
logout()
posthog.reset()
}
const navigate = (target) => {
setPage(target)
posthog.capture('$pageview', { $current_url: `/${target}` })
}
return (
<header className="header">
<div className="header-container">
<nav>
<button onClick={() => navigate('home')} className={page === 'home' ? 'active' : ''}>
Home
</button>
{user && (
<>
<button onClick={() => navigate('burrito')} className={page === 'burrito' ? 'active' : ''}>
Burrito Consideration
</button>
<button onClick={() => navigate('profile')} className={page === 'profile' ? 'active' : ''}>
Profile
</button>
</>
)}
</nav>
<div className="user-section">
{user ? (
<>
<span>Welcome, {user.username}!</span>
<button onClick={handleLogout} className="btn-logout">
Logout
</button>
</>
) : (
<span>Not logged in</span>
)}
</div>
</div>
</header>
)
}
src/contexts/AuthContext.jsx
import { createContext, useContext, useState } from 'react'
const AuthContext = createContext(undefined)
const users = new Map()
export function AuthProvider({ children }) {
const [user, setUser] = useState(() => {
if (typeof window === 'undefined') return null
const storedUsername = localStorage.getItem('currentUser')
if (storedUsername) {
return users.get(storedUsername) || null
}
return null
})
const [page, setPage] = useState('home')
const login = async (username, password) => {
if (!username || !password) return false
let localUser = users.get(username)
if (!localUser) {
localUser = { username, burritoConsiderations: 0 }
users.set(username, localUser)
}
setUser(localUser)
localStorage.setItem('currentUser', username)
return true
}
const logout = () => {
setUser(null)
setPage('home')
localStorage.removeItem('currentUser')
}
const setUserState = (newUser) => {
setUser(newUser)
users.set(newUser.username, newUser)
}
return (
<AuthContext.Provider value={{ user, login, logout, setUser: setUserState, page, setPage }}>
{children}
</AuthContext.Provider>
)
}
export function useAuth() {
const context = useContext(AuthContext)
if (context === undefined) {
throw new Error('useAuth must be used within an AuthProvider')
}
return context
}
src/main.jsx
import './globals.css'
import { StrictMode } from 'react'
import ReactDOM from 'react-dom/client'
import App from './App'
import posthog from 'posthog-js'
import { PostHogErrorBoundary, PostHogProvider } from '@posthog/react'
posthog.init(import.meta.env.VITE_PUBLIC_POSTHOG_PROJECT_TOKEN, {
api_host: import.meta.env.VITE_PUBLIC_POSTHOG_HOST,
defaults: '2026-01-30',
})
const root = document.getElementById('root')
if (!root) throw new Error('Root element not found')
ReactDOM.createRoot(root).render(
<StrictMode>
<PostHogProvider client={posthog}>
<PostHogErrorBoundary>
<App />
</PostHogErrorBoundary>
</PostHogProvider>
</StrictMode>,
)
src/pages/Burrito.jsx
import { useAuth } from '../contexts/AuthContext'
import { usePostHog } from '@posthog/react'
export default function Burrito() {
const { user, setUser } = useAuth()
const posthog = usePostHog()
if (!user) return null
const handleConsider = () => {
const updatedUser = {
...user,
burritoConsiderations: user.burritoConsiderations + 1,
}
setUser(updatedUser)
posthog.capture('burrito_considered', {
total_considerations: updatedUser.burritoConsiderations,
})
}
return (
<div className="container">
<h1>Burrito Consideration Zone</h1>
<div className="burrito-stats">
<p>Times considered: <strong>{user.burritoConsiderations}</strong></p>
<button onClick={handleConsider} className="btn-burrito">
Consider a Burrito
</button>
</div>
<div className="burrito-info">
<h2>Why Consider Burritos?</h2>
<ul>
<li>They are delicious</li>
<li>They are portable</li>
<li>They contain multiple food groups</li>
<li>They bring joy</li>
</ul>
</div>
</div>
)
}
src/pages/Home.jsx
import { useState } from 'react'
import { useAuth } from '../contexts/AuthContext'
import { usePostHog } from '@posthog/react'
export default function Home() {
const { user, login } = useAuth()
const posthog = usePostHog()
const [username, setUsername] = useState('')
const [password, setPassword] = useState('')
const [error, setError] = useState('')
const handleSubmit = async (e) => {
e.preventDefault()
setError('')
const success = await login(username, password)
if (success) {
posthog.identify(username, { name: username })
posthog.capture('user_logged_in')
setUsername('')
setPassword('')
} else {
setError('Please provide both username and password')
}
}
if (user) {
return (
<div className="container">
<h1>Welcome back, {user.username}!</h1>
<p>You are now logged in. Feel free to explore:</p>
<ul>
<li>Consider the potential of burritos</li>
<li>View your profile and statistics</li>
</ul>
</div>
)
}
return (
<div className="container">
<h1>Welcome to Burrito Consideration App</h1>
<p>Please sign in to begin your burrito journey</p>
<form onSubmit={handleSubmit} className="form">
<div className="form-group">
<label htmlFor="username">Username:</label>
<input
type="text"
id="username"
value={username}
onChange={(e) => setUsername(e.target.value)}
placeholder="Enter any username"
/>
</div>
<div className="form-group">
<label htmlFor="password">Password:</label>
<input
type="password"
id="password"
value={password}
onChange={(e) => setPassword(e.target.value)}
placeholder="Enter any password"
/>
</div>
{error && <p className="error">{error}</p>}
<button type="submit" className="btn-primary">Sign In</button>
</form>
<p className="note">
Note: This is a demo app. Use any username and password to sign in.
</p>
</div>
)
}
src/pages/Profile.jsx
import { useAuth } from '../contexts/AuthContext'
export default function Profile() {
const { user } = useAuth()
if (!user) return null
return (
<div className="container">
<h1>User Profile</h1>
<div className="stats">
<h2>Your Information</h2>
<p><strong>Username:</strong> {user.username}</p>
<p><strong>Burrito Considerations:</strong> {user.burritoConsiderations}</p>
</div>
<div style={{ marginTop: '2rem' }}>
<h3>Your Burrito Journey</h3>
{user.burritoConsiderations === 0 ? (
<p>You haven't considered any burritos yet. Visit the Burrito Consideration page to start!</p>
) : user.burritoConsiderations < 5 ? (
<p>You're getting the hang of burrito consideration!</p>
) : user.burritoConsiderations < 10 ? (
<p>You're becoming a burrito consideration expert!</p>
) : (
<p>You are a true burrito consideration master!</p>
)}
</div>
</div>
)
}
vite.config.js
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
export default defineConfig({
plugins: [react()],
})
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 API key, 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/posthog/all/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 omnibus-instrument-integration.zip