PostHog SDKs

https://posthog.com/docs/libraries
Admin
PostHog provides official and community-maintained SDKs for multiple programming languages and...
Tokens:153,259
Snippets:2,120
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Gems

Source: https://posthog.com/docs/libraries/ruby-on-rails

Run this command to install the added gems.

```bash
bundle install
```

--------------------------------

### Install PostHog SDKs

Source: https://posthog.com/docs/libraries/tanstack-start

Install the required React and Node.js packages for client-side and server-side analytics.

```bash
npm install @posthog/react posthog-node
```

--------------------------------

### Configure Web setup

Source: https://posthog.com/docs/libraries/kmp

Initialize PostHog using the no-argument PostHogContext for web applications.

```kotlin
// main.kt
fun main() {
    PostHog.setup(
        config = PostHogConfig(apiKey = "<ph_project_token>"),
        context = PostHogContext(),
    )
}
```

--------------------------------

### Configure JVM desktop setup

Source: https://posthog.com/docs/libraries/kmp

Initialize PostHog for Compose Multiplatform desktop applications.

```kotlin
// main.kt
fun main() = application {
    PostHog.setup(
        config = PostHogConfig(apiKey = "<ph_project_token>"),
        context = PostHogContext(),
    )
    Window(onCloseRequest = ::exitApplication) { App() }
}
```

--------------------------------

### Install @posthog/next package

Source: https://posthog.com/docs/libraries/next-js/posthog-next

Commands to install the package using various package managers.

```bash
npm install --save @posthog/next
```

```bash
yarn add @posthog/next
```

```bash
pnpm add @posthog/next
```

```bash
bun add @posthog/next
```

--------------------------------

### Configure iOS setup

Source: https://posthog.com/docs/libraries/kmp

Initialize PostHog using the no-argument PostHogContext within the iOS entry point.

```kotlin
// MainViewController.kt
fun MainViewController() = ComposeUIViewController {
    LaunchedEffect(Unit) {
        PostHog.setup(
            config = PostHogConfig(apiKey = "<ph_project_token>"),
            context = PostHogContext(),
        )
    }
    App()
}
```

--------------------------------

### Initialize PostHog Client

Source: https://posthog.com/docs/libraries/node

Basic setup for the PostHog client using a project token and host URL.

```javascript
import { PostHog } from 'posthog-node'
const client = new PostHog(
    '<ph_project_token>',
    { host: 'https://us.i.posthog.com' }
)
await client.shutdown()
```

--------------------------------

### Configure Android setup

Source: https://posthog.com/docs/libraries/kmp

Initialize PostHog within the Application class to ensure proper lifecycle management.

```kotlin
import android.app.Application
class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        PostHog.setup(
            config = PostHogConfig(apiKey = "<ph_project_token>"),
            context = PostHogContext(this),
        )
    }
}
```

--------------------------------

### Install PostHog Node library

Source: https://posthog.com/docs/libraries/cloudflare-workers

Install the required dependency using npm.

```bash
npm i posthog-node
```

--------------------------------

### Install Vercel Flags SDK Adapter

Source: https://posthog.com/docs/libraries/vercel

Install the necessary packages to use the PostHog adapter with the Vercel Flags SDK.

```bash
npm i flags @flags-sdk/posthog
```

--------------------------------

### Configure iOS Info.plist for Automatic Initialization

Source: https://posthog.com/docs/libraries/flutter

Add PostHog configuration keys to the Info.plist file for automatic setup.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <!-- rest of your configuration -->
    <key>com.posthog.posthog.PROJECT_TOKEN</key>
    <string><ph_project_token></string>
    <key>com.posthog.posthog.POSTHOG_HOST</key>
    <string>https://us.i.posthog.com</string>
    <!-- com.posthog.posthog.CAPTURE_APPLICATION_LIFECYCLE_EVENTS is enabled by default since version 5.23.0 -->
    <key>com.posthog.posthog.DEBUG</key>
    <true/>
</dict>
</plist>
```

--------------------------------

### Complete middleware configuration

Source: https://posthog.com/docs/libraries/django

A comprehensive example combining custom tags, request filtering, tag modification, and exception capturing.

```python
# settings.py
def add_request_context(request):
    # type: (HttpRequest) -> Dict[str, Any]
    tags = {}
    if hasattr(request, 'user') and request.user.is_authenticated:
        tags['user_type'] = 'authenticated'
        # Use pk instead of id so this works with custom User primary keys.
        tags['user_id'] = str(request.user.pk)
    else:
        tags['user_type'] = 'anonymous'
    # Add request info
    tags['user_agent'] = request.META.get('HTTP_USER_AGENT', '')
    return tags
def filter_tracking(request):
    # type: (HttpRequest) -> bool
    # Skip internal endpoints
    return not request.path.startswith(('/health', '/metrics', '/admin'))
def clean_tags(tags):
    # type: (Dict[str, Any]) -> Dict[str, Any]
    # Remove sensitive data
    tags.pop('user_agent', None)
    return tags
POSTHOG_MW_EXTRA_TAGS = add_request_context
POSTHOG_MW_REQUEST_FILTER = filter_tracking
POSTHOG_MW_TAG_MAP = clean_tags
POSTHOG_MW_CAPTURE_EXCEPTIONS = True
```

--------------------------------

### Install PostHog Convex component

Source: https://posthog.com/docs/libraries/convex

Commands to install the @posthog/convex package using various package managers.

```bash
npm install @posthog/convex
```

```bash
yarn add @posthog/convex
```

```bash
pnpm add @posthog/convex
```

```bash
bun add @posthog/convex
```

--------------------------------

### Initialize PostHog with log configuration

Source: https://posthog.com/docs/libraries/js/config

Configure log-related OpenTelemetry attributes during the initial PostHog setup.

```javascript
posthog.init('<ph_project_token>', {
  api_host: 'https://us.i.posthog.com',
  logs: {
    serviceName: 'checkout-web',
    environment: 'production',
    serviceVersion: '1.2.3',
  },
})
```

--------------------------------

### posthog.startSessionRecording

Source: https://posthog.com/docs/libraries/js/usage

Starts the session recording. Optionally accepts an object to override sampling or feature flag settings.

```APIDOC
## posthog.startSessionRecording(options)

### Description
Starts session recording. You can optionally pass an object with `linked_flag` or `sampling` to override default recording behavior.

### Parameters
- **options** (object) - Optional - Configuration object containing `linked_flag` (boolean) or `sampling` (boolean).
```

--------------------------------

### Install PostHog for React Native

Source: https://posthog.com/docs/libraries/react-native

Use these commands to install the library and required native dependencies for standard React Native projects.

```bash
yarn add posthog-react-native @react-native-async-storage/async-storage react-native-device-info react-native-localize
# or
npm i -s posthog-react-native @react-native-async-storage/async-storage react-native-device-info react-native-localize
```

--------------------------------

### Install PostHog Generator

Source: https://posthog.com/docs/libraries/ruby-on-rails

Run this command to generate the PostHog initializer file in your Rails project.

```bash
rails generate posthog:install
```

--------------------------------

### Default and Strict Script Versioning URLs

Source: https://posthog.com/docs/libraries/js/snippet-versioning

Examples of how feature scripts are loaded using compatibility query strings versus strict versioned paths.

```text
/static/recorder.js?v=1.380.0
```

```text
/static/1.380.0/recorder.js
```

--------------------------------

### Install PostHog SDK with Bun

Source: https://posthog.com/docs/libraries/js

Use this command to add the PostHog JavaScript SDK to your project using the Bun package manager.

```bash
bun add posthog-js
```

--------------------------------

### Configure Tracing Headers for OkHttp

Source: https://posthog.com/docs/libraries/android

Install the PostHogOkHttpInterceptor on OkHttpClient to inject tracing headers into network requests for specific hostnames.

```kotlin
import com.posthog.PostHogOkHttpInterceptor
import com.posthog.android.PostHogAndroid
import com.posthog.android.PostHogAndroidConfig
import okhttp3.OkHttpClient
val config = PostHogAndroidConfig(
    apiKey = POSTHOG_API_KEY,
    host = POSTHOG_HOST,
).apply {
    tracingHeaders = listOf("api.example.com")
}
PostHogAndroid.setup(this, config)
val okHttpClient = OkHttpClient.Builder()
    .addInterceptor(PostHogOkHttpInterceptor())
    .build()
```

--------------------------------

### Install posthog-js via package manager

Source: https://posthog.com/docs/libraries/js

Use your preferred package manager to add the PostHog SDK to your project.

```bash
npm install --save posthog-js
```

```bash
yarn add posthog-js
```

```bash
pnpm add posthog-js
```

--------------------------------

### PostHog.Setup()

Source: https://posthog.com/docs/libraries/unity

Initializes the PostHog SDK with configuration settings.

```APIDOC
### Method
`PostHog.Setup(PostHogConfig config)`

### Parameters
- **ApiKey** (string) - The project API token.
- **Host** (string) - The PostHog instance URL.
- **LogLevel** (PostHogLogLevel) - The verbosity of logs (None, Error, Warning, Info, Debug).
```

--------------------------------

### HTML: PostHog Script Tag Installation Example

Source: https://posthog.com/docs/libraries/js/types

This HTML snippet demonstrates how PostHog is typically loaded into a webpage using a script tag. It includes the initialization call with an API key and host. This is the scenario where external TypeScript types might be needed.

```html
<script>
    !function(t,e){...}(document,window.posthog||[]);
    posthog.init('your-api-key', { api_host: 'https://us.i.posthog.com' })
</script>
```

--------------------------------

### TypeScript: Using `window.posthog` with Type Safety

Source: https://posthog.com/docs/libraries/js/types

This TypeScript example demonstrates how to use `window.posthog` after applying the global type declaration. It shows type-safe calls to `capture`, `identify`, and `getFeatureFlag` methods, ensuring correct usage and autocompletion.

```typescript
// Your code
window.posthog?.capture('button_clicked', { button_id: 'signup' })
window.posthog?.identify('user-123', { email: 'user@example.com' })
const flagValue = window.posthog?.getFeatureFlag('my-flag')
if (flagValue === 'variant-a') {
    // ...
}
```

--------------------------------

### PostHog.setup

Source: https://posthog.com/docs/libraries/kmp

Initializes the PostHog SDK with the required configuration and context.

```APIDOC
### PostHog.setup

### Description
Initializes the PostHog SDK instance. This should be called during application startup.

### Parameters
- **config** (PostHogConfig) - Required - The configuration object containing the API key and other settings.
- **context** (PostHogContext) - Required - The platform-specific context.

### Example
```kotlin
PostHog.setup(
    config = PostHogConfig(apiKey = "<ph_project_token>", debug = true),
    context = PostHogContext(),
)
```
```

--------------------------------

### PostHog.Setup

Source: https://posthog.com/docs/libraries/unity

Initializes the PostHog SDK with specific configuration options.

```APIDOC
## PostHog.Setup(PostHogConfig config)

### Description
Configures the PostHog SDK, including API keys and error tracking behavior.

### Parameters
- **config** (PostHogConfig) - Required - Configuration object containing ApiKey, CaptureExceptions, ExceptionDebounceIntervalMs, and CaptureExceptionsInEditor.

### Example
```csharp
PostHog.Setup(new PostHogConfig
{
    ApiKey = "<ph_project_token>",
    CaptureExceptions = true,
    ExceptionDebounceIntervalMs = 1000,
    CaptureExceptionsInEditor = true
});
```
```

--------------------------------

### Initialize PostHog with Bootstrapped Flags

Source: https://posthog.com/docs/libraries/ios/usage

Configure the PostHog SDK with initial identity and flag values before calling setup to ensure immediate availability.

```swift
let config = PostHogConfig(projectToken: "<ph_project_token>", host: "https://us.i.posthog.com")
config.bootstrap = PostHogBootstrapConfig(
    distinctId: "distinct_id_of_your_user",
    isIdentifiedId: true,
    featureFlags: [
        "flag-1": true,
        "variant-flag": "control"
    ],
    featureFlagPayloads: nil
)
PostHogSDK.shared.setup(config)
```

--------------------------------

### Terminal: Install PostHog Types Package

Source: https://posthog.com/docs/libraries/js/types

These commands show how to install the `@posthog/types` package using different package managers (npm, yarn, pnpm). This package provides TypeScript definitions for PostHog, primarily for script tag installations.

```bash
npm install @posthog/types
# or
yarn add @posthog/types
# or
pnpm add @posthog/types
```

--------------------------------

### Implement consent-aware setup

Source: https://posthog.com/docs/libraries/next-js/posthog-next

Disable anonymous cookie seeding in middleware and initialize the client with capturing disabled to support consent-based tracking.

```typescript
export default postHogMiddleware({
    proxy: true,
    seedAnonymousCookie: false,
})
```

```jsx
<PostHogProvider clientOptions={{ opt_out_capturing_by_default: true }}>{children}</PostHogProvider>
```

--------------------------------

### Install PostHog dependencies

Source: https://posthog.com/docs/libraries/remix

Install the required PostHog packages via npm.

```bash
npm install --save posthog-js @posthog/react
```

--------------------------------

### Bootstrap PostHog Android SDK

Source: https://posthog.com/docs/libraries/android

Configure the SDK with initial identity and flag values before calling setup to ensure immediate availability.

```kotlin
import com.posthog.PostHogBootstrapConfig
val config = PostHogAndroidConfig(apiKey = POSTHOG_API_KEY, host = POSTHOG_HOST)
config.bootstrap = PostHogBootstrapConfig(
    distinctId = "distinct_id_of_your_user",
    isIdentifiedId = true,
    featureFlags = mapOf(
        "flag-1" to true,
        "variant-flag" to "control"
    )
)
PostHogAndroid.setup(this, config)
```

--------------------------------

### Upgrade PostHog React Native SDK Versions

Source: https://posthog.com/docs/libraries/react-native

Examples showing the evolution of PostHog initialization and usage from V1 through V4.

```jsx
// DEPRECATED V1 Setup
import PostHog from 'posthog-react-native'
await PostHog.setup('<ph_project_token>', {
    // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
    host: 'https://us.i.posthog.com',
    captureApplicationLifecycleEvents: false, // Replaced by 'PostHogProvider'
    captureDeepLinks: false, // No longer supported
    recordScreenViews: false, // Replaced by 'PostHogProvider' supporting @react-navigation/native
    flushInterval: 30, // Stays the same
    flushAt: 20, // Stays the same
    android: {...}, // No longer needed
    iOS: {...}, // No longer needed
})
PostHog.capture("foo")
// V2 Setup difference
import PostHog from 'posthog-react-native'
const posthog = await Posthog.initAsync('<ph_project_token>', {
    // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
    host: 'https://us.i.posthog.com',
    // Add any other options here.
})
// Use created instance rather than the PostHog class
posthog.capture("foo")
// V3 Setup difference
import PostHog from 'posthog-react-native'
const posthog = new PostHog('<ph_project_token>', {
    // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
    host: 'https://us.i.posthog.com',
    // Add any other options here.
})
// Use created instance rather than the PostHog class
posthog.capture("foo")
// V4 Setup difference
import PostHog from 'posthog-react-native'
const posthog = new PostHog('<ph_project_token>', {
    // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
    host: 'https://us.i.posthog.com',
    // captureAppLifecycleEvents is enabled by default since version 4.39.0 (previously named `captureNativeAppLifecycleEvents` or `autocapture={{ captureLifecycleEvents: true }}`)
    // captureMode: 'json', // No longer supported
    // maskPhotoLibraryImages: true, // No longer supported
})
posthog.setPersonPropertiesForFlags(...) // instead of `personProperties`
posthog.setGroupPropertiesForFlags(...) // instead of `groupProperties`
```

--------------------------------

### PostHog.Setup

Source: https://posthog.com/docs/libraries/unity

Initializes the PostHog SDK with Session Replay enabled and custom configuration options.

```APIDOC
## PostHog.Setup

### Description
Initializes the PostHog SDK with specific configuration for Session Replay.

### Parameters
- **PostHogConfig** (object) - Required - Configuration object containing ApiKey, Host, SessionReplay (bool), and SessionReplayConfig.

### Request Example
```csharp
PostHog.Setup(new PostHogConfig
{
    ApiKey = "<ph_project_token>",
    Host = "https://us.i.posthog.com",
    SessionReplay = true,
    SessionReplayConfig = new PostHogSessionReplayConfig
    {
        ThrottleDelaySeconds = 1.0f,
        ScreenshotQuality = 80,
        ScreenshotScale = 0.75f,
        CaptureNetworkTelemetry = true,
        CaptureLogs = false,
        MinLogLevel = SessionReplayLogLevel.Warning,
        FlushAt = 20,
        FlushIntervalSeconds = 30,
        MaxQueueSize = 100
    }
});
```
```

--------------------------------

### Initialize PostHog SDK

Source: https://posthog.com/docs/libraries/php

Configure the SDK with your project token and host URL.

```php
PostHog\PostHog::init("<ph_project_token>",
  ['host' => 'https://us.i.posthog.com']
);
```

--------------------------------

### Install PostHog Capacitor Plugin

Source: https://posthog.com/docs/libraries/capacitor

Installs the necessary npm packages for PostHog integration with Capacitor. This includes the Capacitor plugin and the posthog-js library. After installation, Capacitor project files need to be updated.

```bash
npm install @capawesome/capacitor-posthog posthog-js
npx cap update
```

--------------------------------

### Initialize PostHog on the Server

Source: https://posthog.com/docs/libraries/roblox

Initialize the SDK in a server script using your project API key and host URL.

```lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local PostHog = require(ReplicatedStorage:WaitForChild("PostHog"))
PostHog:Init({
    apiKey = "<ph_project_token>",
    host = "https://us.i.posthog.com", -- usually https://us.i.posthog.com or https://eu.i.posthog.com
})
```

--------------------------------

### Install PostHog for Expo

Source: https://posthog.com/docs/libraries/react-native

Use this command to install the necessary packages for an Expo-based React Native project.

```bash
npx expo install posthog-react-native expo-file-system expo-application expo-device expo-localization
```

--------------------------------

### Install PostHog TypeScript types

Source: https://posthog.com/docs/libraries/js

Install the types package to enable type safety for the PostHog SDK.

```bash
npm install @posthog/types
```

--------------------------------

### Initialize PostHog Client

Source: https://posthog.com/docs/libraries/ruby

Create a singleton client instance with your project token and host configuration.

```ruby
require 'posthog'
posthog = PostHog::Client.new({
  api_key: "<ph_project_token>",
  host: "https://us.i.posthog.com",
  on_error: Proc.new { |status, msg| print msg }
})
```

```ruby
require 'posthog'
posthog = PostHog::Client.new({
  api_key: '<ph_project_token>',
  host: 'https://us.i.posthog.com',
  on_error: Proc.new { |status, msg| print msg }
})
```

--------------------------------

### Initialize PostHog Client

Source: https://posthog.com/docs/libraries/python

Import the library and initialize the client with your project token and host URL.

```python
from posthog import Posthog
posthog = Posthog('<ph_project_token>', host='https://us.i.posthog.com')
```

--------------------------------

### Install PostHog dependencies

Source: https://posthog.com/docs/libraries/convex

Commands to install the required PostHog packages using various package managers.

```bash
npm install posthog-js @posthog/react
```

```bash
yarn add posthog-js @posthog/react
```

```bash
pnpm add posthog-js @posthog/react
```

```bash
bun add posthog-js @posthog/react
```

--------------------------------

### Initialize PostHog Client

Source: https://posthog.com/docs/libraries/go

Create a new client instance using your API key and configuration. The client should be closed before the application exits.

```go
package main
import (
    "os"
    "github.com/posthog/posthog-go"
)
func main() {
    client, _ := posthog.NewWithConfig(
        os.Getenv("POSTHOG_API_KEY"),
        posthog.Config{
            PersonalApiKey: "your personal API key", // Optional, but much more performant.  If this token is not supplied, then fetching feature flag values will be slower.
            Endpoint:       "https://us.i.posthog.com",
        },
    )
    defer client.Close()
    // run commands
}
```

--------------------------------

### Install PostHog Node.js Package

Source: https://posthog.com/docs/libraries/hono

Installs the 'posthog-node' package using npm. This is the first step to enable PostHog integration in your Hono application.

```bash
npm install --save posthog-node
```

--------------------------------

### TypeScript: PostHog JS SDK Usage with Included Types

Source: https://posthog.com/docs/libraries/js/types

This TypeScript code shows how to import and use the PostHog JS SDK when installed via npm or yarn. It highlights that TypeScript types are already included with these packages, making explicit type installations unnecessary for this method.

```typescript
// Types are already available when you install posthog-js
import posthog from 'posthog-js'
posthog.init('your-api-key')
posthog.capture('my_event') // ✅ Fully typed
```

--------------------------------

### Install PostHog via CocoaPods

Source: https://posthog.com/docs/libraries/ios

Add the PostHog dependency to your Podfile.

```ruby
pod "PostHog", "~> 3.59.3"
```

--------------------------------

### Initialize PostHog in React

Source: https://posthog.com/docs/libraries/convex

Setup the PostHog provider at the root of your React application.

```jsx
// src/main.tsx
import { StrictMode } from "react"
import { createRoot } from "react-dom/client"
import posthog from "posthog-js"
import { PostHogProvider } from "@posthog/react"
import App from "./App"
posthog.init(import.meta.env.VITE_POSTHOG_PROJECT_TOKEN, {
    api_host: import.meta.env.VITE_POSTHOG_HOST,
})
createRoot(document.getElementById("root")!).render(
    <StrictMode>
        <PostHogProvider client={posthog}>
            <App />
        </PostHogProvider>
    </StrictMode>
)
```

--------------------------------

### Create Layout Directory and File

Source: https://posthog.com/docs/libraries/astro

Terminal commands to navigate to the layouts directory and create the PostHogLayout file.

```bash
cd .. && cd .. # move back to your base directory if you're still in src/components/posthog.astro
cd ./src/layouts
# or 'cd ./src && mkdir layouts && cd ./layouts' if your layouts folder doesn't exist yet
touch PostHogLayout.astro
```

--------------------------------

### PostHog.init

Source: https://posthog.com/docs/libraries/ruby-on-rails

Initializes the PostHog client with core configuration options.

```APIDOC
## PostHog.init

### Description
Initializes the PostHog client. This should be called during application startup.

### Parameters
- **api_key** (String) - Required - Your PostHog project token.
- **host** (String) - Optional - Fully qualified PostHog API host (default: https://us.i.posthog.com).
- **test_mode** (Boolean) - Optional - If true, events are queued but not sent (default: false).
- **sync_mode** (Boolean) - Optional - If true, events are sent synchronously (default: false).
- **max_queue_size** (Integer) - Optional - Max events in queue (default: 10000).

### Example
```ruby
PostHog.init do |config|
  config.api_key = '<ph_project_token>'
  config.test_mode = true
end
```
```

--------------------------------

### Install gatsby-plugin-posthog

Source: https://posthog.com/docs/libraries/gatsby

Use yarn or npm to add the PostHog plugin to your Gatsby project.

```bash
yarn add gatsby-plugin-posthog
```

```bash
npm install --save gatsby-plugin-posthog
```

--------------------------------

### PostHog::init

Source: https://posthog.com/docs/libraries/php

Initializes the PostHog client with your project token and host configuration.

```APIDOC
## PostHog::init

### Description
Initializes the PostHog client. It is recommended to use environment variables `POSTHOG_API_KEY` and `POSTHOG_HOST` instead of hardcoding values.

### Parameters
- **token** (string) - Required - Your PostHog project token.
- **options** (array) - Optional - Configuration options including 'host'.
```

--------------------------------

### Setup SharedPostHogProvider for react-native-navigation

Source: https://posthog.com/docs/libraries/react-native

Create a shared provider to wrap screens when using react-native-navigation.

```typescript
import PostHog, { PostHogProvider } from 'posthog-react-native'
import { Navigation } from 'react-native-navigation';
export const posthog = new PostHog('<ph_project_token>');
export const SharedPostHogProvider = (props: any) => {
  return (
    <PostHogProvider client={posthog} autocapture={{
      captureScreens: false, // Screen events are handled differently for react-native-navigation
      captureTouches: true,
    }}>
      {props.children}
    </PostHogProvider>
  );
};
```

--------------------------------

### PostHog::init

Source: https://posthog.com/docs/libraries/php

Initializes the PostHog client with a project token and an array of configuration options.

```APIDOC
## PostHog::init

### Description
Initializes the PostHog client instance. This method must be called before tracking events or evaluating feature flags.

### Method
Static Method

### Parameters
- **project_token** (string) - Required - The project API key from your PostHog instance.
- **options** (array) - Optional - Configuration settings for the client.

### Configuration Options
- **host** (string) - URL of your PostHog instance.
- **ssl** (boolean) - Whether to use SSL for API requests.
- **timeout** (integer) - Request timeout in milliseconds.
- **verify_batch_events_request** (boolean) - Whether to verify successful delivery of batch events.
- **feature_flag_request_timeout_ms** (integer) - Request timeout for feature flags in milliseconds.
- **flag_definition_cache_provider** (PostHog\FlagDefinitionCacheProvider) - Provider for distributed local-evaluation flag definition caching.
- **maximum_backoff_duration** (integer) - Request retry backoff duration.
- **consumer** (string) - Transport option (socket, file, lib_curl, fork_curl, noop).
- **debug** (boolean) - Enable or disable debug logs.
- **max_queue_size** (integer) - Maximum number of events to queue.
- **batch_size** (integer) - Number of queued events to send in each batch.
- **compress_request** (boolean/string) - Whether to gzip batch request payloads.
- **error_handler** (callable) - Callback invoked for SDK transport errors.
- **filename** (string) - File path used when consumer is set to file.
- **error_tracking** (array) - Configuration for automatic error tracking.
```

--------------------------------

### Initialize PostHog with Slim Bundle and Extensions

Source: https://posthog.com/docs/libraries/js

Use the slim bundle to reduce initial payload size and explicitly opt-in to specific features via extension bundles.

```javascript
import posthog from 'posthog-js/dist/module.slim'
import {
    SessionReplayExtensions,
    AnalyticsExtensions,
} from 'posthog-js/dist/extension-bundles'
posthog.init('<ph_project_token>', {
    api_host: 'https://us.i.posthog.com',
    defaults: '2026-05-30',
    __extensionClasses: {
        ...SessionReplayExtensions,
        ...AnalyticsExtensions,
    }
})
```

--------------------------------

### Initialization

Source: https://posthog.com/docs/libraries/python

Initialize the PostHog client with your project token and host URL.

```APIDOC
## Posthog Initialization

### Description
Initialize the PostHog client instance to enable event capturing and feature flag evaluation.

### Parameters
- **project_token** (string) - Required - Your PostHog project API token.
- **host** (string) - Required - The URL of your PostHog instance (e.g., 'https://us.i.posthog.com').

### Example
```python
from posthog import Posthog
posthog = Posthog('<ph_project_token>', host='https://us.i.posthog.com')
```
```

--------------------------------

### Survey object structure

Source: https://posthog.com/docs/libraries/js/usage

Example of the JSON structure returned when fetching survey data.

```json
[{
  "id": "your_survey_id",
  "name": "Your survey name",
  "description": "Metadata describing your survey",
  "type": "api", // either "api", "popover", or "widget"
  "linked_flag_key": null, // linked feature flag key, if any.
  "targeting_flag_key": "your_survey_targeting_flag_key",
  "questions": [
    {
      "type": "single_choice",
      "choices": [
        "Yes",
        "No"
      ],
      "question": "Are you enjoying PostHog?"
    }
  ],
  "conditions": null,
  "start_date": "2023-09-19T13:10:49.505000Z",
  "end_date": null
}]
```

--------------------------------

### Initialize PostHog SDK

Source: https://posthog.com/docs/libraries/js

Initialize the SDK in your web application using your project token and host URL.

```javascript
import posthog from 'posthog-js'
posthog.init('<ph_project_token>', {
  api_host: 'https://us.i.posthog.com',
  defaults: '2026-05-30'
})
```

--------------------------------

### PostHog::init

Source: https://posthog.com/docs/libraries/php

Initializes the PostHog client with a project token and configuration options.

```APIDOC
## PostHog::init

### Description
Initializes the PostHog client. This must be called before tracking events.

### Parameters
- **project_token** (string) - Required - The project API key.
- **options** (array) - Optional - Configuration options including 'host' and 'debug' mode.
```

--------------------------------

### Install PostHog Java SDK via Maven

Source: https://posthog.com/docs/libraries/java

Add the posthog-server dependency to your pom.xml file.

```xml
<dependency>
  <groupId>com.posthog</groupId>
  <artifactId>posthog-server</artifactId>
  <version>LATEST</version>
</dependency>
```

--------------------------------

### Initialize PostHog client

Source: https://posthog.com/docs/libraries/vercel

Create a reusable PostHog client instance configured for serverless execution.

```javascript
// app/posthog.js
import { PostHog } from 'posthog-node'
export default function PostHogClient() {
  const posthogClient = new PostHog('<ph_project_token>', {
    host: 'https://us.i.posthog.com',
    flushAt: 1, // flush immediately in serverless environment
    flushInterval: 0 // same
  })
  return posthogClient
}
```

--------------------------------

### Install PostHog Java SDK via Gradle

Source: https://posthog.com/docs/libraries/java

Add the posthog-server dependency to your build.gradle file.

```kotlin
dependencies {
  implementation 'com.posthog:posthog-server:2.+'
}
```

--------------------------------

### PostHog:Init

Source: https://posthog.com/docs/libraries/roblox

Initializes the PostHog SDK with your project API key and configuration options.

```APIDOC
### PostHog:Init

#### Description
Initializes the PostHog SDK. This must be called before using other SDK methods.

#### Parameters
- **config** (table) - Required - Configuration table containing:
  - **apiKey** (string) - Required - Your PostHog project API key.
  - **captureErrors** (boolean) - Optional - Whether to enable automatic error capture (default: true).
  - **errorDebounceSeconds** (number) - Optional - Minimum gap between auto-captured server errors (default: 1).
```

--------------------------------

### Bootstrap identity in Kotlin SDK

Source: https://posthog.com/docs/libraries/bootstrapping

Configure the PostHogAndroidConfig with bootstrap settings before passing it to the setup method.

```kotlin
val config = PostHogAndroidConfig(apiKey = "<ph_project_token>", host = "https://us.i.posthog.com")
config.bootstrap = PostHogBootstrapConfig(
    distinctId = "distinct_id_of_your_user",
    isIdentifiedId = true
)
PostHogAndroid.setup(this, config)
```

--------------------------------

### Initialize PostHog SDK

Source: https://posthog.com/docs/libraries/roblox

Configure the SDK during initialization, including settings for automatic error capture and debouncing.

```lua
PostHog:Init({
    apiKey = "<ph_project_token>",
    captureErrors = true,        -- Enable automatic capture (default: true)
    errorDebounceSeconds = 1,    -- Minimum gap between auto-captured server errors (default: 1)
})
```

--------------------------------

### Example of generated analytics data

Source: https://posthog.com/docs/libraries/ios/usage

The structure of the captured element data after applying a custom label.

```swift
<UITextField id="usernameTextField">text value</UITextField>
```

--------------------------------

### Manually Control Session Recording

Source: https://posthog.com/docs/libraries/unity

Start or stop session recording programmatically using the PostHogSDK.

```csharp
// Check if Session Replay is active
if (PostHogSDK.IsSessionReplayActive)
{
    // Stop recording
    PostHogSDK.StopSessionReplay();
}
// Start recording (if not already active)
PostHogSDK.StartSessionReplay();
```

--------------------------------

### Initialize PostHog Java Client

Source: https://posthog.com/docs/libraries/java

Configure the PostHog client with your project token and host, then ensure proper shutdown using flush and close.

```java
import com.posthog.server.PostHog;
import com.posthog.server.PostHogConfig;
import com.posthog.server.PostHogInterface;
class Sample {
  private static final String POSTHOG_API_KEY = "<ph_project_token>";
  private static final String POSTHOG_HOST = "https://us.i.posthog.com";
  public static void main(String args[]) {
    PostHogConfig config = PostHogConfig
            .builder(POSTHOG_API_KEY)
            .host(POSTHOG_HOST)
            .build();
    PostHogInterface posthog = PostHog.with(config);
    posthog.flush(); // send any remaining events
    posthog.close(); // shut down the client
  }
}
```

--------------------------------

### Install PostHog Android via Gradle

Source: https://posthog.com/docs/libraries/android

Add the dependency to your project's build configuration files.

```gradle
dependencies {
  implementation 'com.posthog:posthog-android:3.+'
}
```

```kotlin
dependencies {
  implementation("com.posthog:posthog-android:3.+")
}
```

--------------------------------

### Initialize SDK for Local Evaluation

Source: https://posthog.com/docs/libraries/php

Initialize the PostHog SDK with a personal API key to enable local feature flag evaluation.

```php
PostHog::init(
    '<ph_project_token>',
    ['host' => 'https://us.i.posthog.com'],
    personalAPIKey: 'your feature flags secure API key'
);
```

--------------------------------

### Verify PostHog middleware

Source: https://posthog.com/docs/libraries/ruby-on-rails

Check the Rails application middleware stack to ensure PostHog is properly installed.

```ruby
Rails.application.middleware
```

--------------------------------

### Initialize PostHog via HTML snippet

Source: https://posthog.com/docs/libraries/js

Add this script to your HTML to initialize PostHog. Replace <ph_project_token> with your actual project token.

```html
<script>
    !function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.crossOrigin="anonymous",p.async=!0,p.src=s.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="init capture register register_once register_for_session unregister unregister_for_session getFeatureFlag getFeatureFlagResult isFeatureEnabled reloadFeatureFlags updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures on onFeatureFlags onSessionId getSurveys getActiveMatchingSurveys renderSurvey canRenderSurvey getNextSurveyStep identify setPersonProperties group resetGroups setPersonPropertiesForFlags resetPersonPropertiesForFlags setGroupPropertiesForFlags resetGroupPropertiesForFlags reset get_distinct_id getGroups get_session_id get_session_replay_url alias set_config startSessionRecording stopSessionRecording sessionRecordingStarted captureException loadToolbar get_property getSessionProperty createPersonProfile opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing clear_opt_in_out_capturing debug".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
    posthog.init('<ph_project_token>', {
        api_host: 'https://us.i.posthog.com',
        defaults: '2026-05-30',
    })
</script>
```

--------------------------------

### Run PostHog Wizard

Source: https://posthog.com/docs/libraries/next-js

Use the PostHog wizard to automatically integrate the SDK into your Next.js project.

```bash
npx @posthog/wizard
```

--------------------------------

### Install PostHog Docusaurus plugin

Source: https://posthog.com/docs/libraries/docusaurus

Use npm or yarn to add the PostHog plugin to your Docusaurus project.

```bash
npm install --save posthog-docusaurus
```

```bash
yarn add posthog-docusaurus
```

--------------------------------

### Initialize PostHog PHP Client

Source: https://posthog.com/docs/libraries/php

Use this snippet to initialize the PostHog client with custom configuration options.

```php
PostHog::init(
    '<ph_project_token>',
    [
        'host' => 'https://us.i.posthog.com',
        'debug' => true,
        'ssl' => false,
        // all options go here
    ],
);
```

--------------------------------

### Initialize PostHog with Tracing Headers

Source: https://posthog.com/docs/libraries/astro

Configure the PostHog client with your project token and specify hostnames for tracing headers to link frontend and backend events.

```javascript
posthog.init('<ph_project_token>', {
  api_host: 'https://us.i.posthog.com',
  // Optional: send PostHog session/user context to your backend
  tracing_headers: ['api.example.com'],
})
```

--------------------------------

### Initializing PostHog with debug mode

Source: https://posthog.com/docs/libraries/php

Configure the client with a project token and enable debug mode to assist with development and troubleshooting.

```php
PostHog::init(
    '<ph_project_token>',
    [
        'host' => 'https://us.i.posthog.com',
        'debug' => true,
    ],
);
```

--------------------------------

### Capture events and identify users

Source: https://posthog.com/docs/libraries/convex

Example of using identify and capture methods within a Convex mutation.

```typescript
// convex/users.ts
import { mutation } from "./_generated/server"
import { v } from "convex/values"
import { getAuthUserId } from "@convex-dev/auth/server"
import { posthog } from "./posthog"
export const updateProfile = mutation({
    args: { plan: v.string() },
    handler: async (ctx, args) => {
        const userId = await getAuthUserId(ctx)
        if (userId === null) throw new Error("Not authenticated")
        await ctx.db.patch(userId, { plan: args.plan })
        await posthog.identify(ctx, {
            distinctId: userId,
            properties: { plan: args.plan },
        })
        await posthog.capture(ctx, {
            distinctId: userId,
            event: "plan_changed",
            properties: { plan: args.plan },
        })
    },
})
```

--------------------------------

### posthog.NewWithConfig

Source: https://posthog.com/docs/libraries/go

Initializes a new PostHog client instance with the specified API key and configuration settings.

```APIDOC
## posthog.NewWithConfig

### Description
Initializes a new PostHog client. It is recommended to provide a PersonalApiKey for better performance when fetching feature flags.

### Parameters
- **apiKey** (string) - Required - The project API key.
- **config** (posthog.Config) - Required - Configuration object including Endpoint and optional PersonalApiKey.
```

--------------------------------

### Session Replay Control Methods

Source: https://posthog.com/docs/libraries/unity

Methods to check status and manually start or stop session recording.

```APIDOC
## PostHogSDK.IsSessionReplayActive

### Description
Returns a boolean indicating if session recording is currently active.

## PostHogSDK.StartSessionReplay()

### Description
Manually starts the session recording process.

## PostHogSDK.StopSessionReplay()

### Description
Manually stops the session recording process.
```

--------------------------------

### PostHog:Init

Source: https://posthog.com/docs/libraries/roblox

Initializes the PostHog SDK. You can provide configuration options such as the API key, host, and log level.

```APIDOC
## PostHog:Init(options)

### Description
Initializes the PostHog SDK. This should be called before capturing events.

### Parameters
- **options** (table) - Optional - Configuration table containing:
  - **apiKey** (string) - The project API token.
  - **host** (string) - The PostHog instance URL.
  - **logLevel** (string) - The verbosity of logs: "none", "error", "warn", "info", "debug".
  - **captureErrors** (boolean) - Whether to automatically capture errors (default: true).
  - **enableClientRelay** (boolean) - Whether to enable client-side event relaying (default: true).
```

--------------------------------

### Retrieve Session Replay URL

Source: https://posthog.com/docs/libraries/js/usage

Get the playback URL for the current session, optionally including a timestamp.

```javascript
posthog.get_session_replay_url(
  { withTimestamp: true, timestampLookBack: 30 }
)
```

--------------------------------

### PostHog Initialization

Source: https://posthog.com/docs/libraries/node

Initialize the PostHog client with project credentials and configuration options such as GeoIP settings.

```APIDOC
## PostHog Initialization

### Description
Initializes the PostHog client instance.

### Parameters
- **project_token** (string) - Required - Your PostHog project API key.
- **options** (object) - Optional - Configuration object.
  - **host** (string) - The PostHog instance URL.
  - **disableGeoip** (boolean) - Whether to disable automatic GeoIP property resolution.
```

--------------------------------

### Get all evaluated feature flags in Kotlin

Source: https://posthog.com/docs/libraries/kmp

Retrieve a map containing all currently evaluated feature flags.

```kotlin
val allFlags = PostHog.getAllFeatureFlags()
```

--------------------------------

### Get multivariate flag value in Kotlin

Source: https://posthog.com/docs/libraries/kmp

Retrieve the specific variant value for a multivariate feature flag.

```kotlin
when (PostHog.getFeatureFlag("pricing_experiment")) {
    "control" -> showOriginalPricing()
    "variant_a" -> showNewPricing()
    "variant_b" -> showPremiumPricing()
}
```

--------------------------------

### Initialize PostHog in Unity

Source: https://posthog.com/docs/libraries/unity

Use this to programmatically configure the PostHog SDK during game startup. Ensure any existing PostHogSettings.asset is removed from the Resources folder to prevent double initialization.

```csharp
using PostHogUnity;
using UnityEngine;
public class GameManager : MonoBehaviour
{
    void Start()
    {
        PostHog.Setup(new PostHogConfig
        {
            ApiKey = "<ph_project_token>",
            Host = "https://us.i.posthog.com" // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
        });
    }
}
```

--------------------------------

### Configure PostHog instance

Source: https://posthog.com/docs/libraries/react-native

Initialize the PostHog client with custom flush thresholds and intervals.

```javascript
const posthog = new PostHog('<ph_project_token>', {
  flushAt: 20,
  flushInterval: 10000,
})
```

--------------------------------

### Configure iOS Info.plist for Manual Initialization

Source: https://posthog.com/docs/libraries/flutter

Disable automatic initialization in the Info.plist file for manual SDK setup.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <!-- rest of your configuration -->
    <key>com.posthog.posthog.AUTO_INIT</key>
    <false/>
</dict>
</plist>
```

--------------------------------

### Create PostHog component file

Source: https://posthog.com/docs/libraries/astro

Commands to navigate to the components directory and create the posthog.astro file.

```bash
cd ./src/components
# or 'cd ./src && mkdir components && cd ./components' if your components folder doesnt exist
touch posthog.astro
```

--------------------------------

### Initialize PostHog Client for Next.js

Source: https://posthog.com/docs/libraries/next-js

Creates a singleton-like client instance configured for immediate flushing, suitable for short-lived server-side environments.

```javascript
// app/posthog.js
import { PostHog } from 'posthog-node'
export default function PostHogClient() {
  const posthogClient = new PostHog(process.env.NEXT_PUBLIC_POSTHOG_PROJECT_TOKEN, {
    host: process.env.NEXT_PUBLIC_POSTHOG_HOST,
    flushAt: 1,
    flushInterval: 0
  })
  return posthogClient
}
```

--------------------------------

### Override Session Recording Defaults

Source: https://posthog.com/docs/libraries/js/usage

Force a session recording to start by overriding feature flag or sampling constraints.

```javascript
posthog.startSessionRecording({ linked_flag: true, sampling: true })
```

--------------------------------

### Configure Environment Variables

Source: https://posthog.com/docs/libraries/laravel

Add your PostHog project token and host URL to the .env file.

```bash
POSTHOG_API_KEY=<ph_project_token>
POSTHOG_HOST=https://us.i.posthog.com
```

--------------------------------

### Retrieve feature flag variant in Nuxt

Source: https://posthog.com/docs/libraries/nuxt-js

Use the useFeatureFlagVariantKey composable to get the specific variant key for an experiment.

```html
<script setup>
const variant = useFeatureFlagVariantKey('experiment')
// returns the variant string, true/false, or undefined
</script>
<template>
  <div v-if="variant === 'control'">Control group</div>
  <div v-else-if="variant === 'test'">Test group</div>
</template>
```

--------------------------------

### PostHog::init

Source: https://posthog.com/docs/libraries/php

Initializes the PostHog client with configuration options, including request timeouts.

```APIDOC
## PostHog::init

### Description
Initializes the PostHog client. Use this to set the project token, host, and global configuration like request timeouts.

### Parameters
- **project_token** (string) - Required - Your PostHog project token.
- **options** (array) - Optional - Configuration options including 'host' and 'feature_flag_request_timeout_ms'.
```
Tokens:
Raw