.deet context file

A .deet file is a JSON snapshot of your deet project that LLMs and tooling can read.

Use cases

Give LLMs enough structure to suggest new models and fixes
Share a clean project overview during onboarding and handoffs
Drive CI automation with targets and policy profiles (no secrets)
Keep templates and examples consistent across teams

Generate or update

deet context
deet context path/to/.deet
deet init my-project --context

What goes inside

project: name, description, versions, timestamps
directory_structure: source/tests/output layout
data_sources: connectors + required env var names
models: file list with optional purpose annotations
dependencies: from rxg.toml
environment: env var metadata (values are never included)
build_config: target backends + policy profile
metrics: optional goals + KPIs
development: framework + package manager

Templates

Minimal local project (DuckDB)

{
  "project": {
    "name": "starter",
    "description": "Local analytics sandbox",
    "version": "0.1.0",
    "rxg_version": "0.2.0",
    "created_at": "2026-01-04T00:00:00.000Z",
    "last_updated": "2026-01-04T00:00:00.000Z"
  },
  "directory_structure": {
    "root": "/path/to/starter",
    "source_dir": "src",
    "test_dir": "tests",
    "output_dir": "dist"
  },
  "data_sources": [],
  "models": [
    {
      "file": "src/main.rxg",
      "name": "main",
      "type": "module",
      "purpose": "Entry point for example models"
    }
  ],
  "dependencies": {
    "std": "^0.2.0"
  },
  "environment": {
    "variables": []
  },
  "build_config": {
    "target": "duckdb",
    "enabled_targets": ["duckdb"],
    "policy_profile": "dev"
  },
  "metrics": {},
  "development": {
    "framework": "deet/RXG",
    "package_manager": "npm",
    "test_framework": "DuckDB"
  }
}

Warehouse analytics (BigQuery)

{
  "project": {
    "name": "warehouse-analytics",
    "description": "Revenue and retention reporting",
    "version": "0.3.0",
    "rxg_version": "0.2.0",
    "created_at": "2026-01-04T00:00:00.000Z",
    "last_updated": "2026-01-04T00:00:00.000Z"
  },
  "directory_structure": {
    "root": "/path/to/warehouse-analytics",
    "source_dir": "src",
    "test_dir": "tests",
    "output_dir": "dist"
  },
  "data_sources": [
    {
      "name": "warehouse",
      "kind": "bigquery",
      "configuration": {
        "project": "acme-prod",
        "dataset": "analytics"
      },
      "environment_variables": ["BIGQUERY_SERVICE_ACCOUNT_JSON"]
    }
  ],
  "models": [
    {
      "file": "src/funnel.rxg",
      "name": "funnel_metrics",
      "type": "model",
      "purpose": "Stage-by-stage conversion metrics"
    }
  ],
  "dependencies": {
    "std": "^0.2.0"
  },
  "environment": {
    "variables": [
      {
        "name": "BIGQUERY_SERVICE_ACCOUNT_JSON",
        "description": "BigQuery service account json",
        "is_sensitive": true,
        "present": false
      }
    ]
  },
  "build_config": {
    "target": "bigquery",
    "enabled_targets": ["bigquery"],
    "policy_profile": "prod"
  },
  "metrics": {
    "goals": ["Ship daily revenue reporting by 9am UTC"],
    "key_performance_indicators": ["Revenue", "Active subscriptions", "Churn rate"]
  },
  "development": {
    "framework": "deet/RXG",
    "package_manager": "npm",
    "test_framework": "DuckDB"
  }
}

Multi-target + policy profile

{
  "project": {
    "name": "compliance-mart",
    "description": "Regulated reporting pipeline",
    "version": "1.2.0",
    "rxg_version": "0.2.0",
    "created_at": "2026-01-04T00:00:00.000Z",
    "last_updated": "2026-01-04T00:00:00.000Z"
  },
  "directory_structure": {
    "root": "/path/to/compliance-mart",
    "source_dir": "src",
    "test_dir": "tests",
    "output_dir": "dist"
  },
  "data_sources": [
    {
      "name": "primary",
      "kind": "postgres",
      "configuration": {
        "host": "db.internal",
        "port": 5432
      },
      "environment_variables": ["PGHOST", "PGUSER", "PGPASSWORD", "PGDATABASE"]
    }
  ],
  "models": [
    {
      "file": "src/audit.rxg",
      "name": "audit_exports",
      "type": "model",
      "purpose": "Audit-ready data exports"
    }
  ],
  "dependencies": {
    "std": "^0.2.0"
  },
  "environment": {
    "variables": [
      {
        "name": "PGPASSWORD",
        "description": "primary password",
        "is_sensitive": true,
        "present": false
      }
    ]
  },
  "build_config": {
    "target": "postgres",
    "enabled_targets": ["postgres", "duckdb"],
    "policy_profile": "regulated"
  },
  "metrics": {},
  "development": {
    "framework": "deet/RXG",
    "package_manager": "npm",
    "test_framework": "DuckDB"
  }
}

Tips

Add // Purpose: comments in .rxg files to populate model purpose.
Regenerate after adding sources, models, or new build targets.
Commit the file if you want LLMs and teammates to have full context.