Install pgflow

Let’s set up pgflow in your Supabase project. This setup needs to be done only once per project.

Prerequisites

• Supabase CLI version 2.0.2 or higher (check with supabase -v)
• A local Supabase project set up
• Deno version 1.45.2 or higher (2.x also supported) - required for flow compilation

If you haven’t installed the CLI yet or need to upgrade, see Supabase’s installation guide.

1. Install pgflow

   Run the installer with npx:

   npx pgflow@latest install

   Want to understand what’s happening? See the manual installation guide.

2. Apply configuration changes

   Restart your Supabase instance to apply the configuration changes:

   npx supabase stop
   npx supabase start

3. Apply migrations

   Apply the migrations to create the pgflow schema and tables:

   npx supabase migrations up

Your Supabase project now has everything needed to create and run flows with pgflow!

Next Steps

Build Multi-Step Flows

Coordinate multiple steps with dependencies, data flow between steps, and real-time progress tracking. Perfect for AI pipelines, data processing, and complex automation.

Create your first flow

Need simple background jobs?

For single-step tasks without orchestration - just reliable task queue processing on Supabase with retries and observability.

Use background jobs