installation.mdx

title	Install pgflow
description	Quick setup guide for pgflow on Supabase. Set up the flow engine in your project with a simple npx command.
sidebar	order 10
prev	false
next	false

import { Aside, Steps, LinkButton } from "@astrojs/starlight/components"; import { FileTree } from '@astrojs/starlight/components';

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

- Supabase CLI version **2.50.3** or higher (check with `supabase -v`) - A local Supabase project set up

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

   - supabase/ - flows/ - greet-user.ts (example flow) - index.ts (exports) - functions/ - pgflow/ (Control Plane for compilation) - greet-user-worker/ (runs the example) - migrations/ - ..._install_pgflow.sql

   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

import { Card } from '@astrojs/starlight/components';

See pgflow in action in 5 minutes using the scaffolded GreetUser flow. Quickstart

Need simple background jobs?

For single-step tasks without orchestration, see background jobs.