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://mp-staging.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-ruby.md
PostHog ruby Example Project
Repository: https://github.com/PostHog/context-mill Path: basics/ruby
README.md
PostHog Ruby Example - CLI Todo App
A simple command-line todo application built with plain Ruby (no frameworks) demonstrating PostHog integration for CLIs, scripts, data pipelines, and non-web Ruby applications.
Purpose
This example serves as:
Verification that the context-mill wizard works for plain Ruby projects
Reference implementation of PostHog best practices for non-framework Ruby code
Working example you can run and modify
Features Demonstrated
Instance-based API - Uses
PostHog::Client.new(...)for explicit client managementProper shutdown - Uses
shutdowninensureblock to flush events before exitEvent tracking - Captures user actions with
distinct_idand propertiesUser identification - Associates properties with users via
identifyError handling - Manual exception capture for handled errors
Quick Start
1. Install Dependencies
# Install bundler if needed
gem install bundler
# Install dependencies
bundle install2. Configure PostHog
# Copy environment template
cp .env.example .env
# Edit .env and add your PostHog project token
# POSTHOG_PROJECT_TOKEN=phc_your_project_token_here
# POSTHOG_HOST=https://us.i.posthog.com3. Run the App
# Add a todo
ruby todo.rb add "Buy groceries"
# List all todos
ruby todo.rb list
# Complete a todo
ruby todo.rb complete 1
# Delete a todo
ruby todo.rb delete 1
# Show statistics
ruby todo.rb statsWhat Gets Tracked
The app tracks these events in PostHog:
| Event | Properties | Purpose |
|---|---|---|
todo_added | todo_id, todo_length, total_todos | When user adds a new todo |
todos_viewed | total_todos, completed_todos | When user lists todos |
todo_completed | todo_id, time_to_complete_hours | When user completes a todo |
todo_deleted | todo_id, was_completed | When user deletes a todo |
stats_viewed | total_todos, completed_todos, pending_todos | When user views stats |
Code Structure
basics/ruby/
├── todo.rb # Main CLI application
├── Gemfile # Ruby dependencies
├── .env.example # Environment variable template
├── .gitignore # Git ignore rules
└── README.md # This fileKey Implementation Patterns
1. Instance-Based Initialization
require 'posthog-ruby'
posthog = PostHog::Client.new(
api_key: api_key,
host: 'https://us.i.posthog.com',
on_error: proc { |status, msg| puts "PostHog error: #{status} - #{msg}" }
)2. Event Tracking Pattern
# Track events with distinct_id
posthog.capture(
distinct_id: 'user_123',
event: 'event_name',
properties: { key: 'value' }
)3. Proper Shutdown
begin
# Your application code
ensure
# Always call shutdown to flush events and close connections
posthog&.shutdown
end4. Identifying Users
# Identify users (optional - adds user properties)
posthog.identify(
distinct_id: 'user_123',
properties: { email: '[email protected]', plan: 'pro' }
)Running Without PostHog
The app works fine without PostHog configured - it simply won't track analytics. You'll see a warning message but the app continues to function normally.
Next Steps
Modify
todo.rbto experiment with PostHog trackingAdd new commands and track their usage
Explore feature flags:
posthog.is_feature_enabled('flag-name', 'user_id')Check your PostHog dashboard to see tracked events
Learn More
.env.example
# PostHog Configuration
POSTHOG_PROJECT_TOKEN=phc_your_project_token_here
POSTHOG_HOST=https://us.i.posthog.com
# Optional: Enable debug mode to see PostHog requests
# POSTHOG_DEBUG=true
Gemfile
source 'https://rubygems.org'
gem 'posthog-ruby', '~> 3.0'
gem 'dotenv', '~> 3.0'
todo.rb
#!/usr/bin/env ruby
# frozen_string_literal: true
# Simple CLI Todo App with PostHog Analytics
#
# A minimal plain Ruby CLI application demonstrating PostHog integration
# for non-framework Ruby projects (CLIs, scripts, data pipelines, etc.).
require 'json'
require 'securerandom'
require 'time'
require 'dotenv/load'
require 'posthog'
# Data file location
DATA_FILE = File.join(Dir.home, '.todo_app.json')
def initialize_posthog
# Initialize PostHog with instance-based API.
# Returns PostHog client or nil if project token not configured.
project_token = ENV['POSTHOG_PROJECT_TOKEN']
unless project_token
puts 'WARNING: PostHog not configured (POSTHOG_PROJECT_TOKEN not set)'
puts ' App will work but analytics won\'t be tracked'
return nil
end
PostHog::Client.new(
api_key: project_token,
host: ENV.fetch('POSTHOG_HOST', 'https://us.i.posthog.com'),
on_error: proc { |status, msg| puts "PostHog error: #{status} - #{msg}" }
)
end
def get_user_id
# Get or create a user ID for this installation.
# Uses a UUID stored in the data file to represent this user.
if File.exist?(DATA_FILE)
data = JSON.parse(File.read(DATA_FILE))
return data['user_id'] if data['user_id']
end
"user_#{SecureRandom.hex(4)}"
end
def load_todos
# Load todos from disk.
return { 'user_id' => get_user_id, 'todos' => [] } unless File.exist?(DATA_FILE)
JSON.parse(File.read(DATA_FILE))
end
def save_todos(data)
# Save todos to disk.
File.write(DATA_FILE, JSON.pretty_generate(data))
end
def track_event(posthog, event_name, properties = {})
# Track an event with PostHog.
return unless posthog
posthog.capture(
distinct_id: get_user_id,
event: event_name,
properties: properties
)
end
def cmd_add(text, posthog)
# Add a new todo item.
data = load_todos
todo = {
'id' => data['todos'].length + 1,
'text' => text,
'completed' => false,
'created_at' => Time.now.iso8601
}
data['todos'] << todo
save_todos(data)
puts "Added todo ##{todo['id']}: #{todo['text']}"
track_event(posthog, 'todo_added', {
'todo_id' => todo['id'],
'todo_length' => todo['text'].length,
'total_todos' => data['todos'].length
})
end
def cmd_list(posthog)
# List all todos.
data = load_todos
if data['todos'].empty?
puts "No todos yet! Add one with: ruby todo.rb add 'Your task'"
return
end
puts "\nYour Todos (#{data['todos'].length} total):\n\n"
data['todos'].each do |todo|
status = todo['completed'] ? 'X' : ' '
puts " [#{status}] ##{todo['id']}: #{todo['text']}"
end
puts
track_event(posthog, 'todos_viewed', {
'total_todos' => data['todos'].length,
'completed_todos' => data['todos'].count { |t| t['completed'] }
})
end
def cmd_complete(id, posthog)
# Mark a todo as completed.
data = load_todos
todo = data['todos'].find { |t| t['id'] == id }
unless todo
puts "ERROR: Todo ##{id} not found"
return
end
if todo['completed']
puts "Todo ##{id} is already completed"
return
end
todo['completed'] = true
todo['completed_at'] = Time.now.iso8601
save_todos(data)
puts "Completed todo ##{todo['id']}: #{todo['text']}"
time_to_complete = (Time.parse(todo['completed_at']) - Time.parse(todo['created_at'])) / 3600.0
track_event(posthog, 'todo_completed', {
'todo_id' => todo['id'],
'time_to_complete_hours' => time_to_complete
})
end
def cmd_delete(id, posthog)
# Delete a todo.
data = load_todos
todo = data['todos'].find { |t| t['id'] == id }
unless todo
puts "ERROR: Todo ##{id} not found"
return
end
data['todos'].delete(todo)
save_todos(data)
puts "Deleted todo ##{id}"
track_event(posthog, 'todo_deleted', {
'todo_id' => todo['id'],
'was_completed' => todo['completed']
})
end
def cmd_stats(posthog)
# Show usage statistics.
data = load_todos
total = data['todos'].length
completed = data['todos'].count { |t| t['completed'] }
pending = total - completed
puts "\nStats:\n\n"
puts " Total todos: #{total}"
puts " Completed: #{completed}"
puts " Pending: #{pending}"
puts " Completion rate: #{total > 0 ? format('%.1f', completed.to_f / total * 100) : '0.0'}%"
puts
track_event(posthog, 'stats_viewed', {
'total_todos' => total,
'completed_todos' => completed,
'pending_todos' => pending
})
end
def print_usage
puts <<~USAGE
Simple todo app with PostHog analytics
Usage:
ruby todo.rb add "Todo text" Add a new todo
ruby todo.rb list List all todos
ruby todo.rb complete <id> Mark todo as completed
ruby todo.rb delete <id> Delete a todo
ruby todo.rb stats Show statistics
USAGE
end
# Main entry point
posthog = nil
begin
posthog = initialize_posthog
command = ARGV[0]
unless command
print_usage
exit 0
end
case command
when 'add'
text = ARGV[1]
unless text
puts 'ERROR: Please provide todo text'
puts 'Usage: ruby todo.rb add "Your task"'
exit 1
end
cmd_add(text, posthog)
when 'list'
cmd_list(posthog)
when 'complete'
id = ARGV[1]&.to_i
unless id && id > 0
puts 'ERROR: Please provide a valid todo ID'
puts 'Usage: ruby todo.rb complete <id>'
exit 1
end
cmd_complete(id, posthog)
when 'delete'
id = ARGV[1]&.to_i
unless id && id > 0
puts 'ERROR: Please provide a valid todo ID'
puts 'Usage: ruby todo.rb delete <id>'
exit 1
end
cmd_delete(id, posthog)
when 'stats'
cmd_stats(posthog)
else
puts "ERROR: Unknown command '#{command}'"
print_usage
exit 1
end
rescue StandardError => e
puts "ERROR: #{e.message}"
# Manually capture handled errors
posthog&.capture(
distinct_id: get_user_id,
event: '$exception',
properties: {
'$exception_type' => e.class.name,
'$exception_message' => e.message,
'$exception_list' => [{
'type' => e.class.name,
'value' => e.message,
'stacktrace' => { 'frames' => (e.backtrace || []).first(10).map { |line| { 'filename' => line } } }
}]
}
)
exit 1
ensure
# IMPORTANT: Always shutdown PostHog to flush events
posthog&.shutdown
end
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.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download omnibus-instrument-integration.zip