Version Control

The version control plugin syncs flows to Git repositories (GitHub, GitLab, Bitbucket). Push flow definitions as .flow.ts files, pull changes back, create PRs on publish, and keep flows in sync via webhooks.

Installation

pnpm add @flowlib/version-control

npm install @flowlib/version-control

yarn add @flowlib/version-control

bun add @flowlib/version-control

Setup

The plugin requires a Git provider and a target repository:

import { versionControl } from '@flowlib/version-control';
import { githubProvider } from '@flowlib/version-control/providers/github';

export const flowlibConfig = defineConfig({
  // ...
  plugins: [
    versionControl({
      provider: githubProvider({ token: process.env.GITHUB_TOKEN }),
      repo: 'my-org/my-flows',
    }),
  ],
});

After adding the plugin, regenerate and apply the schema:

npx flowlib-cli generate
npx flowlib-cli migrate --push

Options

How it works

Once configured, you can sync individual flows or all flows at once:

• Push — export a flow from Flowlib to the Git repository
• Pull — import a flow from the Git repository into Flowlib
• Publish — in pr-per-publish mode, creates a pull request for review
• Force push/pull — resolve conflicts by choosing one side as the source of truth
• Webhook — automatically sync when the repository is updated

API endpoints