Skip to content

@sbtools/plugin-typegen

npm

Plugin that generates TypeScript types from the running Supabase instance using the PostgREST types endpoint.

Quick Start

bash
npm install @sbtools/plugin-typegen

Add to config: { "path": "@sbtools/plugin-typegen" }

bash
# Ensure database is running
npx sbt start
npx sbt generate-types
# Output: src/integrations/supabase/types.ts

Commands

CommandDescription
generate-typesFetch types from PostgREST and write to file
$ npx sbt generate-types

Fetching types from http://localhost:54321/rest/v1/?apikey=...
✓ Written to src/integrations/supabase/types.ts (248 tables, 12 views, 34 enums)

Configuration

Plugin config goes in plugins[].config:

json
{
  "plugins": [{
    "path": "@sbtools/plugin-typegen",
    "config": { "typesOutput": "src/types/supabase.ts" }
  }]
}
KeyDefaultDescription
typesOutputsrc/integrations/supabase/types.tsOutput file path

Environment: SUPABASE_TYPES_SCHEMAS to limit schemas (comma-separated).