Skip to content

Latest commit

 

History

History

cli

README.md

pgflow CLI

The Command Line Interface for pgflow - a PostgreSQL-native workflow engine.

Note

This project and all its components are licensed under Apache 2.0 license.

Overview

This package provides essential tools for setting up, managing, and deploying pgflow workflows in your Supabase environment. The CLI handles:

  • Installing pgflow in your Supabase project
  • Compiling TypeScript workflow definitions into SQL migrations
  • Managing workflow deployment and updates

Prerequisites

  • Supabase CLI v2.50.3 or higher
  • Local Supabase project initialized

Installation

Via npx (recommended)

# Run commands directly
npx pgflow@latest <command>

Global installation

# Install globally
npm install -g pgflow

# Run commands
pgflow <command>

Commands

Install pgflow

Set up pgflow in your Supabase project with a single command:

npx pgflow@latest install

Options:

  • --supabase-path <path> - Specify custom Supabase directory path
  • --yes or -y - Skip confirmation prompts (non-interactive mode)

The installer will:

  1. Update config.toml to enable required connection pooling
  2. Copy pgflow SQL migrations to your project
  3. Configure environment variables for Edge Functions
  4. Guide you through applying migrations

Compile Flow Definition

Convert a TypeScript flow definition into a SQL migration:

npx pgflow@latest compile my_flow

Options:

  • --supabase-path <path> - Path to custom Supabase directory
  • --control-plane-url <url> - ControlPlane URL (default: http://127.0.0.1:54321/functions/v1/pgflow)

The compiler will:

  1. Parse your TypeScript flow definition
  2. Extract step dependencies and configuration
  3. Generate SQL commands for database registration
  4. Create a timestamped migration file in your migrations folder

Building

Run nx build cli to build the library.

Running unit tests

Run nx test cli to execute the unit tests via Vitest.

Documentation

For detailed documentation, visit: