PostHog/posthog-definitions

Perfil de PostHog

Última atividade de origem registrada: 14 de maio de 2026 às 13:27

Catálogo do SkillsMP atualizado: 17 de outubro de 2026 às 00:09

skills coletadas: 3

Estrelas no GitHub: 15
Forks no GitHub: 3

README do repositório

Arquivo de origem do README: README.md

Ler o README original

Expandir README completo

# posthog-definitions > [!WARNING] > **Alpha — do not use in production.** > This is pre-MVP software (`0.1.0-alpha.0`). The CLI, the on-disk file format, the SDK surface, and the tag-based identity model are all subject to breaking changes without notice. Use it on throwaway projects or in a sandbox while we stabilize. Infrastructure-as-code for PostHog. Define dashboards, insights, feature flags, actions, endpoints, event definitions, property groups, experiments, experiment holdouts, and experiment saved metrics in TypeScript, then sync them to a PostHog project with one command. ## Why - **Version control your PostHog setup.** Dashboards and flags live next to the app code that emits the events they depend on. - **Code-review changes before they ship.** A renamed metric or a flipped flag is a diff, not a click in the UI. - **Reproduce setups across projects.** Apply the same definitions to staging and prod, or bootstrap a new project from an existing one. ## Install ``` npm install --save-dev @posthog/definitions ``` ## Example ```ts // posthog/dashboards/growth.ts import { dashboard, insight, trends } from "@posthog/definitions"; export default dashboard({ key: "growth", name: "Growth", tiles: [ { insight: insight({ key: "weekly-signups", name: "Weekly signups", query: trends({ series: [{ event: "user signed up" }], interval: "week" }), }), layout: { x: 0, y: 0, w: 6, h: 4 }, }, ], }); ``` ## Workflow 1. **Authenticate** — create a personal API key ([US](https://us.posthog.com/settings/user-api-keys) / [EU](https://eu.posthog.com/settings/user-api-keys)) with these scopes: - `insight:read`, `insight:write` - `dashboard:read`, `dashboard:write` - `feature_flag:read`, `feature_flag:write` - `action:read`, `action:write` - `endpoint:read`, `endpoint:write` - `event_definition:read`, `event_definition:write` (also covers property groups) - `experiment:read`, `experiment:write` (also covers experiment holdouts) - `experiment_saved_metric:read`, `experiment_saved_metric:write` Then add it (and your numeric project ID) to a `.env` (or `.envrc`) file: ``` POSTHOG_PERSONAL_API_KEY=phx_... POSTHOG_PROJECT_ID=000000 # POSTHOG_HOST=https://eu.posthog.com # optional, defaults to us.posthog.com ``` See `.envrc.example` in the repo for a copy-paste starting point. 2. **Write definitions** as `.ts` files under `posthog/`. 3. **Preview the plan** — diff your files against the live project, no writes: ``` npx posthog-definitions apply --dry-run ``` 4. **Apply** — create / update server resources to match: ``` npx posthog-definitions apply ``` 5. **Commit** the `.ts` files. To bootstrap from an existing project, `npx posthog-definitions pull` writes definition files for the dashboards already on the server. ## Docs See [`docs/README.md`](docs/README.md) for the SDK reference, the apply algorithm, the identity model, and the MVP roadmap. ## License MIT

Carregando o README do repositório…

Skills neste repositório

Desenvolvedores de software Analistas de garantia de qualidade de software e testadores

2 categorias ocupacionais · 100% classificado

skill

ocupação

descrição

atualizado

add-resource

Desenvolvedores de software

Add support for a new PostHog resource type (feature flag, cohort, action, survey, annotation, alert, …) to posthog-definitions. Walks through the eight files that must change, the tag-based identity convention, the load/diff/execute pipeline wiring, and the…

Idioma do texto original: inglês

2026-05-14

add-singleton-resource

Desenvolvedores de software

Add support for a PostHog resource that exists exactly once per project (project settings, organization billing config, plugin enablement flags, …). Singletons do not fit the tag-based identity model — they have no collection to filter, no key to…

Idioma do texto original: inglês

2026-05-14

result-vs-exceptions

Analistas de garantia de qualidade de software e testadores

Code review guide for choosing between Result types and thrown exceptions. Recoverable, expected failures should be returned as Result values; only unrecoverable bugs and broken invariants should throw. Use when reviewing code that introduces a new error…

Idioma do texto original: inglês

2026-05-14

Mostrando 3 de 3 skills coletadas.

Instalar com um assistente de IA

Copie este prompt para o assistente de IA que você usa.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/PostHog/posthog-definitions.