generate

opentp generate

Exports your tracking plan to various output formats.

Usage

opentp generate <target> [options]

Targets

Target	Description	Output
json	JSON export	stdout (or --output <file>)
yaml	YAML export	stdout (or --output <file>)
template	Custom template	Configured output

Options

Option	Description
--root <path>	Project root directory
--output <path>	Output file path
--pretty / --no-pretty	Pretty print output (JSON generator; default: true)
--file <path>	Template file path (template generator)
--external-generators <path>	Load custom generators

Examples

Export to JSON

opentp generate json

Prints JSON to stdout. Use --output to write a file.

Export to YAML

opentp generate yaml

Prints YAML to stdout. Use --output to write a file.

Custom output path

opentp generate json --output ./dist/events.json

Using custom generators

opentp generate my-format --external-generators ./my-generators

External generators are loaded only via --external-generators (the spec does not include external plugin loading).

Output Format

JSON Output

{
  "opentp": "2026-01",
  "info": {
    "title": "My App Tracking Plan",
    "version": "1.0.0"
  },
  "events": [
    {
      "key": "auth::login_click",
      "taxonomy": {
        "area": "auth",
        "event": "login_click",
        "action": "User clicks the login button"
      },
      "lifecycle": { "status": "active" },
      "payload": {
        "schema": {
          "event_name": { "value": "login_click" },
          "dimension_1": {
            "type": "string",
            "name": "orgType",
            "example": "enterprise"
          }
        }
      }
    }
  ],
  "dictionaries": {}
}

YAML Output

opentp: 2026-01
info:
  title: My App Tracking Plan
  version: 1.0.0
events:
  - key: auth::login_click
    taxonomy:
      area: auth
      event: login_click
      action: User clicks the login button
    lifecycle:
      status: active
    payload:
      schema:
        event_name:
          value: login_click
        dimension_1:
          type: string
          name: orgType
          example: enterprise
dictionaries: {}

Custom Generators

Create custom generators for any output format:

my-generators/typescript/index.js

module.exports = {
  name: 'typescript',
  generate: async (context) => {
    const { config, events, dictionaries, options } = context;
    // Generate TypeScript SDK
    return {
      files: [
        { path: 'events.ts', content: '...' }
      ]
    };
  }
};

See Custom Generators for details.