Skip to content
pgflow (Workflow Engine for Supabase)
News

Install pgflow

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

  1. Install pgflow

    Section titled “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

    Section titled “Apply configuration changes”

    Restart your Supabase instance to apply the configuration changes:

    npx supabase stop
    npx supabase start

  3. Apply migrations

    Section titled “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

Section titled “Next Steps”

Run the Example

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

Quickstart

Need simple background jobs?

Section titled “Need simple background jobs?”

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

Chat with Author